vendor/contao/core-bundle/src/Resources/contao/library/Contao/Automator.php line 166

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao;
  13. use FOS\HttpCache\CacheInvalidator;
  14. use FOS\HttpCacheBundle\CacheManager;
  15. use Symfony\Component\Console\Input\ArgvInput;
  16. use Symfony\Component\Console\Output\NullOutput;
  18. /**
  19.  * Provide methods to run automated jobs.
  20.  */
  21. class Automator extends System
  22. {
  23.     /**
  24.      * Make the constructor public
  25.      */
  26.     public function __construct()
  27.     {
  28.         parent::__construct();
  29.     }
  31.     /**
  32.      * Purge the search tables
  33.      */
  34.     public function purgeSearchTables()
  35.     {
  36.         // The search indexer is disabled
  37.         if (!System::getContainer()->has('contao.search.indexer'))
  38.         {
  39.             return;
  40.         }
  42.         $searchIndexer = System::getContainer()->get('contao.search.indexer');
  44.         // Clear the index
  45.         $searchIndexer->clear();
  47.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the search tables');
  48.     }
  50.     /**
  51.      * Purge the undo table
  52.      */
  53.     public function purgeUndoTable()
  54.     {
  55.         $objDatabase = Database::getInstance();
  57.         // Truncate the table
  58.         $objDatabase->execute("TRUNCATE TABLE tl_undo");
  60.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the undo table');
  61.     }
  63.     /**
  64.      * Purge the version table
  65.      */
  66.     public function purgeVersionTable()
  67.     {
  68.         $objDatabase = Database::getInstance();
  70.         // Truncate the table
  71.         $objDatabase->execute("TRUNCATE TABLE tl_version");
  73.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the version table');
  74.     }
  76.     /**
  77.      * Purge the system log
  78.      */
  79.     public function purgeSystemLog()
  80.     {
  81.         $objDatabase = Database::getInstance();
  83.         // Truncate the table
  84.         $objDatabase->execute("TRUNCATE TABLE tl_log");
  86.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the system log');
  87.     }
  89.     /**
  90.      * Purge the crawl queue
  91.      */
  92.     public function purgeCrawlQueue()
  93.     {
  94.         $objDatabase = Database::getInstance();
  96.         // Truncate the table
  97.         $objDatabase->execute("TRUNCATE TABLE tl_crawl_queue");
  99.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the crawl queue');
  100.     }
  102.     /**
  103.      * Purge the image cache
  104.      */
  105.     public function purgeImageCache()
  106.     {
  107.         $container = System::getContainer();
  108.         $strTargetPath = StringUtil::stripRootDir($container->getParameter('contao.image.target_dir'));
  109.         $strRootDir = $container->getParameter('kernel.project_dir');
  111.         // Walk through the subfolders
  112.         foreach (Folder::scan($strRootDir . '/' . $strTargetPath) as $dir)
  113.         {
  114.             if (strncmp($dir, '.', 1) !== 0)
  115.             {
  116.                 $objFolder = new Folder($strTargetPath . '/' . $dir);
  117.                 $objFolder->purge();
  118.             }
  119.         }
  121.         // Also empty the shared cache so there are no links to deleted images
  122.         $this->purgePageCache();
  124.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the image cache');
  125.     }
  127.     /**
  128.      * Purge the preview cache
  129.      */
  130.     public function purgePreviewCache()
  131.     {
  132.         $container = System::getContainer();
  133.         $strTargetPath = StringUtil::stripRootDir($container->getParameter('contao.image.preview.target_dir'));
  134.         $strRootDir = $container->getParameter('kernel.project_dir');
  136.         // Walk through the subfolders
  137.         foreach (Folder::scan($strRootDir . '/' . $strTargetPath) as $dir)
  138.         {
  139.             if (strncmp($dir, '.', 1) !== 0)
  140.             {
  141.                 $objFolder = new Folder($strTargetPath . '/' . $dir);
  142.                 $objFolder->purge();
  143.             }
  144.         }
  146.         // Also empty the shared cache so there are no links to deleted previews
  147.         $this->purgePageCache();
  149.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the preview cache');
  150.     }
  152.     /**
  153.      * Purge the script cache
  154.      */
  155.     public function purgeScriptCache()
  156.     {
  157.         // assets/js and assets/css
  158.         foreach (array('assets/js', 'assets/css') as $dir)
  159.         {
  160.             // Purge the folder
  161.             $objFolder = new Folder($dir);
  162.             $objFolder->purge();
  163.         }
  165.         // Recreate the internal style sheets
  166.         $this->import(StyleSheets::class, 'StyleSheets');
  167.         $this->StyleSheets->updateStyleSheets();
  169.         // Also empty the shared cache so there are no links to deleted scripts
  170.         $this->purgePageCache();
  172.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the script cache');
  173.     }
  175.     /**
  176.      * Purge the shared cache
  177.      */
  178.     public function purgePageCache()
  179.     {
  180.         $container = System::getContainer();
  182.         if (!$container->has('fos_http_cache.cache_manager'))
  183.         {
  184.             System::getContainer()->get('monolog.logger.contao.error')->error('Cannot purge the shared cache; invalid reverse proxy configuration');
  186.             return;
  187.         }
  189.         /** @var CacheManager $cacheManager */
  190.         $cacheManager = $container->get('fos_http_cache.cache_manager');
  192.         if (!$cacheManager->supports(CacheInvalidator::CLEAR))
  193.         {
  194.             System::getContainer()->get('monolog.logger.contao.error')->error('Cannot purge the shared cache; invalid reverse proxy configuration');
  196.             return;
  197.         }
  199.         $cacheManager->clearCache();
  201.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the shared cache');
  202.     }
  204.     /**
  205.      * Purge the search cache
  206.      *
  207.      * @deprecated Deprecated since Contao 4.12, to be removed in Contao 5.0.
  208.      */
  209.     public function purgeSearchCache()
  210.     {
  211.         trigger_deprecation('contao/core-bundle', '4.12', 'Using "Contao\Automator::purgeSearchCache()" has been deprecated and will no longer work in Contao 5.0.');
  213.         $strCacheDir = StringUtil::stripRootDir(System::getContainer()->getParameter('kernel.cache_dir'));
  215.         $objFolder = new Folder($strCacheDir . '/contao/search');
  216.         $objFolder->purge();
  218.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the search cache');
  219.     }
  221.     /**
  222.      * Purge the internal cache
  223.      */
  224.     public function purgeInternalCache()
  225.     {
  226.         $container = System::getContainer();
  228.         $clearer = $container->get('contao.cache.clearer');
  229.         $clearer->clear($container->getParameter('kernel.cache_dir'));
  231.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the internal cache');
  232.     }
  234.     /**
  235.      * Purge the temp folder
  236.      */
  237.     public function purgeTempFolder()
  238.     {
  239.         // Purge the folder
  240.         $objFolder = new Folder('system/tmp');
  241.         $objFolder->purge();
  243.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the temp folder');
  244.     }
  246.     /**
  247.      * Purge registrations that have not been activated within 24 hours
  248.      */
  249.     public function purgeRegistrations()
  250.     {
  251.         $objMember = MemberModel::findExpiredRegistrations();
  253.         if ($objMember === null)
  254.         {
  255.             return;
  256.         }
  258.         while ($objMember->next())
  259.         {
  260.             $objMember->delete();
  261.         }
  263.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the unactivated member registrations');
  264.     }
  266.     /**
  267.      * Purge opt-in tokens
  268.      */
  269.     public function purgeOptInTokens()
  270.     {
  271.         $optIn = System::getContainer()->get('contao.opt_in');
  272.         $optIn->purgeTokens();
  274.         System::getContainer()->get('monolog.logger.contao.cron')->info('Purged the expired double opt-in tokens');
  275.     }
  277.     /**
  278.      * Remove old XML files from the share directory
  279.      *
  280.      * @param boolean $blnReturn If true, only return the finds and don't delete
  281.      *
  282.      * @return array An array of old XML files
  283.      */
  284.     public function purgeXmlFiles($blnReturn=false)
  285.     {
  286.         $arrFeeds = array();
  288.         // HOOK: preserve third party feeds
  289.         if (isset($GLOBALS['TL_HOOKS']['removeOldFeeds']) && \is_array($GLOBALS['TL_HOOKS']['removeOldFeeds']))
  290.         {
  291.             foreach ($GLOBALS['TL_HOOKS']['removeOldFeeds'] as $callback)
  292.             {
  293.                 $this->import($callback[0]);
  294.                 $arrFeeds = array_merge($arrFeeds, $this->{$callback[0]}->{$callback[1]}());
  295.             }
  296.         }
  298.         // Delete the old files
  299.         if (!$blnReturn)
  300.         {
  301.             $shareDir = System::getContainer()->getParameter('contao.web_dir') . '/share';
  303.             foreach (Folder::scan($shareDir) as $file)
  304.             {
  305.                 if (is_dir($shareDir . '/' . $file))
  306.                 {
  307.                     continue; // see #6652
  308.                 }
  310.                 $objFile = new File(StringUtil::stripRootDir($shareDir) . '/' . $file);
  312.                 if ($objFile->extension == 'xml' && !\in_array($objFile->filename, $arrFeeds))
  313.                 {
  314.                     $objFile->delete();
  315.                 }
  316.             }
  317.         }
  319.         return $arrFeeds;
  320.     }
  322.     /**
  323.      * Invalidate the cached XML sitemaps
  324.      *
  325.      * @param integer $intId The root page ID
  326.      */
  327.     public function generateSitemap($intId=0)
  328.     {
  329.         $container = System::getContainer();
  331.         if (!$container->has('fos_http_cache.cache_manager'))
  332.         {
  333.             return;
  334.         }
  336.         /** @var CacheManager $cacheManager */
  337.         $cacheManager = $container->get('fos_http_cache.cache_manager');
  338.         $tag = 'contao.sitemap';
  340.         if ($intId > 0)
  341.         {
  342.             $tag .= '.' . $intId;
  343.         }
  345.         $cacheManager->invalidateTags(array($tag));
  346.     }
  348.     /**
  349.      * Regenerate the XML files
  350.      */
  351.     public function generateXmlFiles()
  352.     {
  353.         // Sitemaps
  354.         $this->generateSitemap();
  356.         // HOOK: add custom jobs
  357.         if (isset($GLOBALS['TL_HOOKS']['generateXmlFiles']) && \is_array($GLOBALS['TL_HOOKS']['generateXmlFiles']))
  358.         {
  359.             foreach ($GLOBALS['TL_HOOKS']['generateXmlFiles'] as $callback)
  360.             {
  361.                 $this->import($callback[0]);
  362.                 $this->{$callback[0]}->{$callback[1]}();
  363.             }
  364.         }
  366.         // Also empty the shared cache so there are no links to deleted files
  367.         $this->purgePageCache();
  369.         System::getContainer()->get('monolog.logger.contao.cron')->info('Regenerated the XML files');
  370.     }
  372.     /**
  373.      * Generate the symlinks in the public folder
  374.      */
  375.     public function generateSymlinks()
  376.     {
  377.         $container = System::getContainer();
  379.         $command = $container->get('contao.command.symlinks');
  380.         $status = $command->run(new ArgvInput(array()), new NullOutput());
  382.         if ($status > 0)
  383.         {
  384.             System::getContainer()->get('monolog.logger.contao.error')->error('The symlinks could not be regenerated');
  385.         }
  386.         else
  387.         {
  388.             System::getContainer()->get('monolog.logger.contao.cron')->info('Regenerated the symlinks');
  389.         }
  390.     }
  392.     /**
  393.      * Generate the internal cache
  394.      */
  395.     public function generateInternalCache()
  396.     {
  397.         $container = System::getContainer();
  399.         $warmer = $container->get('contao.cache.warmer');
  400.         $warmer->warmUp($container->getParameter('kernel.cache_dir'));
  402.         System::getContainer()->get('monolog.logger.contao.cron')->info('Generated the internal cache');
  403.     }
  405.     /**
  406.      * Rotate the log files
  407.      *
  408.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  409.      *             Use the logger service instead, which rotates its log files automatically.
  410.      */
  411.     public function rotateLogs()
  412.     {
  413.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Automator::rotateLogs()" has been deprecated and will no longer work in Contao 5.0. Use the logger service instead, which rotates its log files automatically.');
  415.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  416.         $arrFiles = preg_grep('/\.log$/', Folder::scan($projectDir . '/system/logs'));
  418.         foreach ($arrFiles as $strFile)
  419.         {
  420.             // Ignore Monolog log files (see #2579)
  421.             if (preg_match('/-\d{4}-\d{2}-\d{2}\.log$/', $strFile))
  422.             {
  423.                 continue;
  424.             }
  426.             $objFile = new File('system/logs/' . $strFile . '.9');
  428.             // Delete the oldest file
  429.             if ($objFile->exists())
  430.             {
  431.                 $objFile->delete();
  432.             }
  434.             // Rotate the files (e.g. error.log.4 becomes error.log.5)
  435.             for ($i=8; $i>0; $i--)
  436.             {
  437.                 $strGzName = 'system/logs/' . $strFile . '.' . $i;
  439.                 if (file_exists($projectDir . '/' . $strGzName))
  440.                 {
  441.                     $objFile = new File($strGzName);
  442.                     $objFile->renameTo('system/logs/' . $strFile . '.' . ($i+1));
  443.                 }
  444.             }
  446.             // Add .1 to the latest file
  447.             $objFile = new File('system/logs/' . $strFile);
  448.             $objFile->renameTo('system/logs/' . $strFile . '.1');
  449.         }
  450.     }
  451. }
  453. class_alias(Automator::class, 'Automator');