├── modman
├── src
    └── app
    │   ├── etc
    │       └── modules
    │       │   └── Webgriffe_Maintenance.xml
    │   └── code
    │       └── community
    │           └── Webgriffe
    │               └── Maintenance
    │                   ├── controllers
    │                       └── IndexController.php
    │                   ├── Model
    │                       └── System
    │                       │   └── Config
    │                       │       └── Source
    │                       │           └── Show.php
    │                   ├── etc
    │                       ├── config.xml
    │                       └── system.xml
    │                   ├── Helper
    │                       └── Data.php
    │                   └── Controller
    │                       └── Router.php
├── composer.json
└── README.md


/modman:
--------------------------------------------------------------------------------
1 | src/app/code/community/Webgriffe/Maintenance     app/code/community/Webgriffe/Maintenance
2 | src/app/etc/modules/*    app/etc/modules/
3 | 


--------------------------------------------------------------------------------
/src/app/etc/modules/Webgriffe_Maintenance.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <config>
 3 |     <modules>
 4 |         <Webgriffe_Maintenance>
 5 |             <active>true</active>
 6 |             <codePool>community</codePool>
 7 |         </Webgriffe_Maintenance>
 8 |     </modules>
 9 | </config>
10 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "aleron75/webgriffe-maintenance",
 3 |     "type": "magento-module",
 4 |     "license":"OSL-3.0",
 5 |     "description":"Maintenance module for Magento.",
 6 |     "authors":[
 7 |         {
 8 |             "name":"Alessandro Ronchi",
 9 |             "email":"aleron75@gmail.com"
10 |         }
11 |     ]
12 | }
13 | 


--------------------------------------------------------------------------------
/src/app/code/community/Webgriffe/Maintenance/controllers/IndexController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | class Webgriffe_Maintenance_IndexController extends Mage_Core_Controller_Front_Action
 3 | {
 4 |     public function indexAction()
 5 |     {
 6 |         $body = Mage::helper('wgmnt')->getCustomMessage();
 7 |         $this->getResponse()->setBody($body);
 8 |     }
 9 | }
10 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Webgriffe_Maintenance
 2 | =====================
 3 | 
 4 | A maintentance module for Magento 
 5 | 
 6 | [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
 7 | 
 8 | Installation
 9 | ------------
10 | Supposed you know what [modman](https://github.com/colinmollenhour/modman) is, you can simply install this module using the following commands:
11 | 
12 | ```
13 | modman init
14 | modman clone git@github.com:aleron75/Webgriffe_Maintenance.git
15 | ```
16 | 
17 | Once installed, clean your Magento cache and compilation (if active) and go to System > Configuration > Advanced > System > Maintenance Page.
18 | 
19 | That's all for now.
20 |  
21 | 


--------------------------------------------------------------------------------
/src/app/code/community/Webgriffe/Maintenance/Model/System/Config/Source/Show.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | class Webgriffe_Maintenance_Model_System_Config_Source_Show
 3 | {
 4 |     const MODE_CMS = 'cms';
 5 |     const MODE_MSG = 'msg';
 6 | 
 7 |     /**
 8 |      * Options getter
 9 |      *
10 |      * @return array
11 |      */
12 |     public function toOptionArray()
13 |     {
14 |         return array(
15 |             array('value' => self::MODE_CMS, 'label'=>Mage::helper('wgmnt')->__('Cms Page')),
16 |             array('value' => self::MODE_MSG, 'label'=>Mage::helper('wgmnt')->__('Custom Message')),
17 |         );
18 |     }
19 | 
20 |     /**
21 |      * Get options in "key-value" format
22 |      *
23 |      * @return array
24 |      */
25 |     public function toArray()
26 |     {
27 |         return array(
28 |             self::MODE_MSG => Mage::helper('wgmnt')->__('Custom Message'),
29 |             self::MODE_CMS => Mage::helper('wgmnt')->__('Cms Page'),
30 |         );
31 |     }
32 | 
33 | }
34 | 


--------------------------------------------------------------------------------
/src/app/code/community/Webgriffe/Maintenance/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <config>
 3 |     <modules>
 4 |         <Webgriffe_Maintenance>
 5 |             <version>1.0.0</version>
 6 |         </Webgriffe_Maintenance>
 7 |     </modules>
 8 |     
 9 |     <global>
10 |         <models>
11 |             <wgmnt>
12 |                 <class>Webgriffe_Maintenance_Model</class>
13 |             </wgmnt>
14 |         </models>
15 | 
16 |         <helpers>
17 |             <wgmnt>
18 |                 <class>Webgriffe_Maintenance_Helper</class>
19 |             </wgmnt>
20 |         </helpers>
21 |         
22 |         <events>
23 |             <controller_front_init_before>
24 |                 <observers>
25 |                     <wgmnt_front_init_before>
26 |                         <type>singleton</type>
27 |                         <class>Webgriffe_Maintenance_Controller_Router</class>
28 |                         <method>initControllerRouters</method>
29 |                     </wgmnt_front_init_before>
30 |                 </observers>
31 |             </controller_front_init_before>
32 |         </events>
33 |     </global>
34 |     
35 |     <frontend>
36 |         <routers>
37 |             <wgmnt>
38 |                 <use>standard</use>
39 |                 <args>
40 |                     <module>Webgriffe_Maintenance</module>
41 |                     <frontName>wgmnt</frontName>
42 |                 </args>
43 |             </wgmnt>
44 |         </routers>
45 |     </frontend>
46 |     
47 |     <default>
48 |         <system>
49 |             <wg_maintenance>
50 |                 <active>0</active>
51 |                 <show>msg</show>
52 |                 <msg>Under maintenance</msg>
53 |                 <debug>1</debug>
54 |             </wg_maintenance>
55 |         </system>
56 |     </default>
57 | </config>
58 | 


--------------------------------------------------------------------------------
/src/app/code/community/Webgriffe/Maintenance/Helper/Data.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | class Webgriffe_Maintenance_Helper_Data extends Mage_Core_Helper_Data {
 3 | 
 4 |     protected function _log($msg) {
 5 |         Mage::log($msg, null, 'Webgriffe_Maintenance.log', Mage::getStoreConfig('system/wg_maintenance/debug'));
 6 |     }
 7 | 
 8 |     protected function _getCurrentIp() {
 9 |         return Mage::app()->getRequest()->getClientIp();
10 |     }
11 | 
12 |     public function isActive() {
13 |         return Mage::getStoreConfig('system/wg_maintenance/active');
14 |     }
15 | 
16 |     public function bypassIp() {
17 |         $bypassedIps = explode(',', Mage::getStoreConfig('system/wg_maintenance/bypassed_ips'));
18 | 
19 |         if ($bypassedIps && !empty($bypassedIps)) {
20 |             for ($i = 0, $count = count($bypassedIps); $i < $count; $i ++) {
21 |                 $bypassedIps[$i] = trim($bypassedIps[$i]);
22 |             }
23 |         }
24 | 
25 |         return ($this->_check($this->_getCurrentIp(), $bypassedIps));
26 |     }
27 | 
28 |     protected function _check($ip, $arr_ip) {
29 |         $this->_log(sprintf("Check incoming IP %s against following IPs: %s", $ip, implode(' - ', $arr_ip)));
30 |         foreach ($arr_ip as $test_ip) {
31 |             $test_ip = str_replace('\*','\d+',preg_quote($test_ip));
32 |             if (preg_match("/^".$test_ip."$/", $ip)) {
33 |                 $this->_log(sprintf('Matched "%s" against "%s"', $ip, $test_ip));
34 |                 return true;
35 |             }
36 |         }
37 |         return false;
38 |     }
39 | 
40 |     public function getMaintenancePageId() {
41 |         return Mage::getStoreConfig('system/wg_maintenance/cms_page');
42 |     }
43 | 
44 |     public function getCustomMessage() {
45 |         return Mage::getStoreConfig('system/wg_maintenance/msg');
46 |     }
47 | 
48 |     public function getShowMode() {
49 |         return Mage::getStoreConfig('system/wg_maintenance/show');
50 |     }
51 | 
52 |     public function isBasicAuthActive()
53 |     {
54 |         return Mage::getStoreConfig('system/wg_basicauth/active');
55 |     }
56 | 
57 |     public function getBasicAuthUsername()
58 |     {
59 |         return Mage::getStoreConfig('system/wg_basicauth/username');
60 |     }
61 | 
62 |     public function getBasicAuthPassword()
63 |     {
64 |         return Mage::getStoreConfig('system/wg_basicauth/password');
65 |     }
66 | }
67 | 


--------------------------------------------------------------------------------
/src/app/code/community/Webgriffe/Maintenance/Controller/Router.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class Webgriffe_Maintenance_Controller_Router extends Mage_Core_Controller_Varien_Router_Abstract {
 4 | 
 5 |     /**
 6 |      * Initialize Controller Router
 7 |      *
 8 |      * @param Varien_Event_Observer $observer
 9 |      */
10 |     public function initControllerRouters($observer) {
11 |         /* @var $front Mage_Core_Controller_Varien_Front */
12 |         $front = $observer->getEvent()->getFront();
13 |         $front->addRouter('maintenance', $this);
14 |     }
15 | 
16 |     public function match(Zend_Controller_Request_Http $request) {
17 |         $helper = Mage::helper('wgmnt');
18 |         if ($helper->isActive() && !$helper->bypassIp()) {
19 |             $adminFrontName = (string) Mage::getConfig()->getNode('admin/routers/adminhtml/args/frontName');
20 |             $str_pos = strpos($request->getPathInfo(), $adminFrontName);
21 |             if (Mage::app()->getStore()->isAdmin() || $str_pos === 1) {
22 |                 return false;
23 |             }
24 | 
25 |             $requestParams = array();
26 | 
27 |             $show = Mage::helper('wgmnt')->getShowMode();
28 | 
29 |             switch ($show) {
30 | 
31 |                 case Webgriffe_Maintenance_Model_System_Config_Source_Show::MODE_CMS:
32 |                     $moduleName = 'cms';
33 |                     $controllerName = 'page';
34 |                     $actionName = 'view';
35 |                     $pageId = $helper->getMaintenancePageId();
36 |                     $requestParams['page_id'] = $pageId;
37 |                     break;
38 | 
39 |                 case Webgriffe_Maintenance_Model_System_Config_Source_Show::MODE_MSG:
40 |                     $moduleName = 'wgmnt';
41 |                     $controllerName = 'index';
42 |                     $actionName = 'index';
43 |                     break;
44 | 
45 |             }
46 | 
47 |             foreach ($requestParams as $paramKey => $paramVal) {
48 |                 $request->setParam($paramKey, $paramVal);
49 |             }
50 | 
51 |             $request
52 |                     ->setModuleName($moduleName)
53 |                     ->setControllerName($controllerName)
54 |                     ->setActionName($actionName);
55 | 
56 |             $response = Mage::app()->getFrontController()->getResponse();
57 |             $response->setHeader('HTTP/1.1','503');
58 |             $response->setHeader('Status','503 Service Unavailable');
59 |         }
60 |         return false;
61 |     }
62 | 
63 | }
64 | 


--------------------------------------------------------------------------------
/src/app/code/community/Webgriffe/Maintenance/etc/system.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <config>
  3 |     <sections>
  4 |         <system>
  5 |             <groups>
  6 |                 <wg_maintenance translate="label">
  7 |                     <label>Maintenance Page</label>
  8 |                     <frontend_type>text</frontend_type>
  9 |                     <sort_order>1000</sort_order>
 10 |                     <show_in_default>1</show_in_default>
 11 |                     <show_in_website>1</show_in_website>
 12 |                     <show_in_store>1</show_in_store>
 13 |                     <fields>
 14 |                         <active translate="label">
 15 |                             <label>Enable Maintenance Page</label>
 16 |                             <frontend_type>select</frontend_type>
 17 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 18 |                             <sort_order>10</sort_order>
 19 |                             <show_in_default>1</show_in_default>
 20 |                             <show_in_website>1</show_in_website>
 21 |                             <show_in_store>1</show_in_store>
 22 |                         </active>
 23 |                         <debug translate="label,comment">
 24 |                             <label>Debug Mode</label>
 25 |                             <comment>If enabled, force logging.</comment>
 26 |                             <frontend_type>select</frontend_type>
 27 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 28 |                             <sort_order>15</sort_order>
 29 |                             <show_in_default>1</show_in_default>
 30 |                             <show_in_website>1</show_in_website>
 31 |                             <show_in_store>1</show_in_store>
 32 |                         </debug>
 33 |                         <show translate="label">
 34 |                             <label>Show</label>
 35 |                             <frontend_type>select</frontend_type>
 36 |                             <source_model>wgmnt/system_config_source_show</source_model>
 37 |                             <sort_order>18</sort_order>
 38 |                             <show_in_default>1</show_in_default>
 39 |                             <show_in_website>1</show_in_website>
 40 |                             <show_in_store>1</show_in_store>
 41 |                         </show>
 42 |                         <cms_page translate="label">
 43 |                             <depends><show>cms</show></depends>
 44 |                             <label>CMS Page</label>
 45 |                             <frontend_type>select</frontend_type>
 46 |                             <source_model>adminhtml/system_config_source_cms_page</source_model>
 47 |                             <sort_order>20</sort_order>
 48 |                             <show_in_default>1</show_in_default>
 49 |                             <show_in_website>1</show_in_website>
 50 |                             <show_in_store>1</show_in_store>
 51 |                         </cms_page>
 52 |                         <msg translate="label,comment">
 53 |                             <depends><show>msg</show></depends>
 54 |                             <label>Custom Message</label>
 55 |                             <comment>HTML is allowed</comment>
 56 |                             <frontend_type>textarea</frontend_type>
 57 |                             <sort_order>25</sort_order>
 58 |                             <show_in_default>1</show_in_default>
 59 |                             <show_in_website>1</show_in_website>
 60 |                             <show_in_store>1</show_in_store>
 61 |                         </msg>
 62 |                         <bypassed_ips translate="label,comment">
 63 |                             <label>Bypassed IPs</label>
 64 |                             <comment>You can specify a comma separated list of IP addresses which bypass the maintenance page. You can also use wildcards, i.e. 192.168.1.*</comment>
 65 |                             <frontend_type>text</frontend_type>
 66 |                             <sort_order>30</sort_order>
 67 |                             <show_in_default>1</show_in_default>
 68 |                             <show_in_website>0</show_in_website>
 69 |                             <show_in_store>0</show_in_store>
 70 |                         </bypassed_ips>
 71 |                     </fields>
 72 |                 </wg_maintenance>
 73 |                 <wg_basicauth translate="label">
 74 |                     <label>Basic Authentication</label>
 75 |                     <frontend_type>text</frontend_type>
 76 |                     <sort_order>1100</sort_order>
 77 |                     <show_in_default>1</show_in_default>
 78 |                     <show_in_website>1</show_in_website>
 79 |                     <show_in_store>1</show_in_store>
 80 |                     <fields>
 81 |                         <active translate="label">
 82 |                             <label>Basic Auth</label>
 83 |                             <frontend_type>select</frontend_type>
 84 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 85 |                             <sort_order>15</sort_order>
 86 |                             <show_in_default>1</show_in_default>
 87 |                             <show_in_website>1</show_in_website>
 88 |                             <show_in_store>1</show_in_store>
 89 |                             <comment>
 90 |                                 If Maintenance page is enabled, then Basic Auth will be ignored.
 91 |                             </comment>
 92 |                         </active>
 93 |                         <username translate="label">
 94 |                             <label>Basic Auth Username</label>
 95 |                             <sort_order>16</sort_order>
 96 |                             <show_in_default>1</show_in_default>
 97 |                             <show_in_website>1</show_in_website>
 98 |                             <show_in_store>1</show_in_store>
 99 |                         </username>
100 |                         <password translate="label">
101 |                             <label>Basic Auth Password</label>
102 |                             <sort_order>17</sort_order>
103 |                             <show_in_default>1</show_in_default>
104 |                             <show_in_website>1</show_in_website>
105 |                             <show_in_store>1</show_in_store>
106 |                         </password>
107 |                     </fields>
108 |                 </wg_basicauth>
109 |             </groups>
110 |         </system>
111 |     </sections>  
112 | </config>
113 | 


--------------------------------------------------------------------------------