copyAccessLogFileTool.php

<?php
 
require(dirname(dirname(dirname(dirname(__FILE__)))) . '/tools/bootstrap.inc.php');
 
// Bring in the file loader folder constants.
import('lib.pkp.classes.task.FileLoader');
 
class CopyAccessLogFileTool extends CommandLineTool {
 
   var $_usageStatsDir;
 
   var $_tmpDir;
 
   var $_usageStatsFiles;
 
   var $_contextPaths;
 
   var $_egrepPath;
 
   function __construct($argv = array()) {
      parent::__construct($argv);
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_ADMIN);
 
      if (count($this->argv) < 1 || count($this->argv) > 2) {
         $this->usage();
         exit(1);
      }
 
      $plugin = PluginRegistry::getPlugin('generic', 'usagestatsplugin'); /* @var $plugin UsageStatsPlugin */
 
      $this->_usageStatsDir = $plugin->getFilesPath();
      $this->_tmpDir = $this->_usageStatsDir . DIRECTORY_SEPARATOR . 'tmp';
 
      // This tool needs egrep path configured.
      $this->_egrepPath = escapeshellarg(Config::getVar('cli', 'egrep'));
      if ($this->_egrepPath == "''") {
         printf(__('admin.error.executingUtil', array('utilPath' => $this->_egrepPath, 'utilVar' => 'egrep')) . "\n");
         exit(1);
      }
 
      // Get a list of files currently inside the usage stats dir.
      $fileLoaderDirs = array(FILE_LOADER_PATH_STAGING, FILE_LOADER_PATH_PROCESSING,
      FILE_LOADER_PATH_ARCHIVE, FILE_LOADER_PATH_REJECT);
 
      $usageStatsFiles = array();
      foreach ($fileLoaderDirs as $dir) {
         $dirFiles =  glob($this->_usageStatsDir . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR . '*');
         if (is_array($dirFiles) && count($dirFiles) > 0) {
            foreach ($dirFiles as $file) {
               if (!is_file($file)) continue;
               $fileBasename = pathinfo($file, PATHINFO_BASENAME);
               if (pathinfo($file, PATHINFO_EXTENSION) == 'gz') {
                  // Always save the filename without compression extension.
                  $fileBasename = substr($fileBasename, 0, -3);
               }
               $usageStatsFiles[] = $fileBasename;
            }
         }
      }
 
      $this->_usageStatsFiles = $usageStatsFiles;
 
      // Get a list of context paths.
      $contextDao =& Application::getContextDAO(); /* @var $contextDao ContextDAO */
      $contextFactory = $contextDao->getAll();
      $contextPaths = array();
      while ($context =& $contextFactory->next()) {
         /* @var $context Context */
         $contextPaths[] = escapeshellarg($context->getPath());
      }
      $contextPaths = implode('/|/', $contextPaths);
      $this->_contextPaths = $contextPaths;
   }
 
   function usage() {
      echo "\n" . __('admin.copyAccessLogFileTool.usage', array('scriptName' => $this->scriptName)) . "\n\n";
   }
 
   function execute() {
      $fileMgr = new FileManager();
      $filesDir = Config::getVar('files', 'files_dir');
      $filePath = current($this->argv);
      $usageStatsDir = $this->_usageStatsDir;
      $tmpDir = $this->_tmpDir;
 
      if ($fileMgr->fileExists($tmpDir, 'dir')) {
         $fileMgr->rmtree($tmpDir);
      }
 
      if (!$fileMgr->mkdir($tmpDir)) {
         printf(__('admin.copyAccessLogFileTool.error.creatingFolder', array('tmpDir' => $tmpDir)) . "\n");
         exit(1);
      }
 
      if ($fileMgr->fileExists($filePath, 'dir')) {
         // Directory.
         $filesToCopy = glob($filePath . DIRECTORY_SEPARATOR . '*');
         foreach ($filesToCopy as $file) {
            // If a base filename is given as a parameter, check it.
            if (count($this->argv) == 2) {
               $baseFilename = $this->argv[1];
               if (strpos(pathinfo($file, PATHINFO_BASENAME), $baseFilename) !== 0) {
                  continue;
               }
            }
 
            $this->_copyFile($file);
         }
      } else {
         if ($fileMgr->fileExists($filePath)) {
            // File.
            $this->_copyFile($filePath);
         } else {
            // Can't access.
            printf(__('admin.copyAccessLogFileTool.error.acessingFile', array('filePath' => $filePath)) . "\n");
         }
      }
 
      $fileMgr->rmtree($tmpDir);
   }
 
 
   //
   // Private helper methods.
   //
   function _copyFile($filePath) {
      $usageStatsFiles = $this->_usageStatsFiles;
      $usageStatsDir = $this->_usageStatsDir;
      $tmpDir = $this->_tmpDir;
      $fileName = pathinfo($filePath, PATHINFO_BASENAME);
      $fileMgr = new FileManager();
 
      $isCompressed = false;
      $uncompressedFileName = $fileName;
      if (pathinfo($filePath, PATHINFO_EXTENSION) == 'gz') {
         $isCompressed = true;
         $uncompressedFileName = substr($fileName, 0, -3);
      }
 
      if (in_array($uncompressedFileName, $usageStatsFiles)) {
         printf(__('admin.copyAccessLogFileTool.warning.fileAlreadyExists', array('filePath' => $filePath)) . "\n");
         return;
      }
 
      $tmpFilePath = $tmpDir . DIRECTORY_SEPARATOR . $fileName;
 
      // Copy the file to a temporary directory.
      if (!$fileMgr->copyFile($filePath, $tmpFilePath)) {
         printf(__('admin.copyAccessLogFileTool.error.copyingFile', array('filePath' => $filePath, 'tmpFilePath' => $tmpFilePath)) . "\n");
         exit(1);
      }
 
      // Uncompress it, if needed.
      if ($isCompressed) {
         $fileMgr = new FileManager();
         try {
            $tmpFilePath = $fileMgr->decompressFile($tmpFilePath);
         } catch (Exception $e) {
            printf($e->getMessage() . "\n");
            exit(1);
         }
      }
 
      // Filter only entries that contains context paths.
      $egrepPath = $this->_egrepPath;
      $destinationPath = $usageStatsDir . DIRECTORY_SEPARATOR .
      FILE_LOADER_PATH_STAGING . DIRECTORY_SEPARATOR .
      pathinfo($tmpFilePath, PATHINFO_BASENAME);
      // Each context path is already escaped, see the constructor.
      $output = null;
      $returnValue = 0;
      exec($egrepPath . " -i '" . $this->_contextPaths . "' " . escapeshellarg($tmpFilePath) . " > " . escapeshellarg($destinationPath), $output, $returnValue);
      if ($returnValue > 1) {
         printf(__('admin.error.executingUtil', array('utilPath' => $egrepPath, 'utilVar' => 'egrep')) . "\n");
         exit(1);
      }
      if (!$fileMgr->deleteByPath($tmpFilePath)) {
         printf(__('admin.copyAccessLogFileTool.error.deletingFile', array('tmpFilePath' => $tmpFilePath)) . "\n");
         exit(1);
      }
 
      printf(__('admin.copyAccessLogFileTool.success', array('filePath' => $filePath, 'destinationPath' => $destinationPath)) . "\n");
   }
}
 
$tool = new CopyAccessLogFileTool(isset($argv) ? $argv : array());
$tool->execute();