123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Framework\App;
- use Magento\Framework\App\Filesystem\DirectoryList;
- use Magento\Framework\Filesystem;
- /**
- * Application Maintenance Mode
- */
- class MaintenanceMode
- {
- /**
- * Maintenance flag file name
- *
- * DO NOT consolidate this file and the IP white list into one.
- * It is going to work much faster in 99% of cases: the isOn() will return false whenever file doesn't exist.
- */
- const FLAG_FILENAME = '.maintenance.flag';
- /**
- * IP-addresses file name
- */
- const IP_FILENAME = '.maintenance.ip';
- /**
- * Maintenance flag dir
- */
- const FLAG_DIR = DirectoryList::VAR_DIR;
- /**
- * Path to store files
- *
- * @var \Magento\Framework\Filesystem\Directory\WriteInterface
- */
- protected $flagDir;
- /**
- * Constructor
- *
- * @param \Magento\Framework\Filesystem $filesystem
- */
- public function __construct(Filesystem $filesystem)
- {
- $this->flagDir = $filesystem->getDirectoryWrite(self::FLAG_DIR);
- }
- /**
- * Checks whether mode is on
- *
- * Optionally specify an IP-address to compare against the white list
- *
- * @param string $remoteAddr
- * @return bool
- */
- public function isOn($remoteAddr = '')
- {
- if (!$this->flagDir->isExist(self::FLAG_FILENAME)) {
- return false;
- }
- $info = $this->getAddressInfo();
- return !in_array($remoteAddr, $info);
- }
- /**
- * Sets maintenance mode "on" or "off"
- *
- * @param bool $isOn
- * @return bool
- */
- public function set($isOn)
- {
- if ($isOn) {
- return $this->flagDir->touch(self::FLAG_FILENAME);
- }
- if ($this->flagDir->isExist(self::FLAG_FILENAME)) {
- return $this->flagDir->delete(self::FLAG_FILENAME);
- }
- return true;
- }
- /**
- * Sets list of allowed IP addresses
- *
- * @param string $addresses
- * @return bool
- * @throws \InvalidArgumentException
- */
- public function setAddresses($addresses)
- {
- $addresses = (string)$addresses;
- if (empty($addresses)) {
- if ($this->flagDir->isExist(self::IP_FILENAME)) {
- return $this->flagDir->delete(self::IP_FILENAME);
- }
- return true;
- }
- if (!preg_match('/^[^\s,]+(,[^\s,]+)*$/', $addresses)) {
- throw new \InvalidArgumentException("One or more IP-addresses is expected (comma-separated)\n");
- }
- $result = $this->flagDir->writeFile(self::IP_FILENAME, $addresses);
- return false !== $result ? true : false;
- }
- /**
- * Get list of IP addresses effective for maintenance mode
- *
- * @return string[]
- */
- public function getAddressInfo()
- {
- if ($this->flagDir->isExist(self::IP_FILENAME)) {
- $temp = $this->flagDir->readFile(self::IP_FILENAME);
- return explode(',', trim($temp));
- } else {
- return [];
- }
- }
- }
|