Enalean / tuleap

plugins/archivedeleteditems/include/archivedeleteditemsPlugin.class.php

<?php
/**
 * Copyright (c) STMicroelectronics 2012. All rights reserved
 * Copyright (c) Enalean, 2015. All Rights Reserved.
 *
 * Tuleap is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Tuleap is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Tuleap. If not, see <http://www.gnu.org/licenses/>.
 */

require_once('common/plugin/Plugin.class.php');

/**
 * Archive
 */
class ArchivedeleteditemsPlugin extends Plugin {

    private $archiveScript;

    /**
     * Constructor of the class
     *
     * @param Integer $id Id of the plugin
     *
     * @return Void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($id) {
        parent::__construct($id);
        $this->setScope(Plugin::SCOPE_SYSTEM);
        $this->archiveScript = $GLOBALS['codendi_bin_prefix'] . "/archive-deleted-items.pl";
        $this->_addHook('archive_deleted_item', 'archive_deleted_item', false);
    }

    /**
     * Obtain ArchiveDeletedItemsPluginInfo instance
     *
     * @return ArchiveDeletedItemsPluginInfo
     */
    public function getPluginInfo() {
        if (!is_a($this->pluginInfo, 'ArchiveDeletedItemsPluginInfo')) {
            require_once('ArchiveDeletedItemsPluginInfo.class.php');
            $this->pluginInfo = new ArchiveDeletedItemsPluginInfo($this);
        }
        return $this->pluginInfo;
    }

    /**
     * Returns the configuration defined for given variable name
     *
     * @param String $key name of the param
     *
     * @return String
     */
    public function getConfigurationParameter($key) {
        return $this->getPluginInfo()->getPropertyValueForName($key);
    }

    /**
     * Copy files to the archiving directory
     *
     * @param Array $params Hook parameters
     *
     * @return Boolean
     */
    public function archive_deleted_item($params) {
        $params['status'] = false;

        if (!empty($params['source_path'])) {
            $source_path = $params['source_path'];
        } else {
            $params['error'] = 'Missing argument source path';
            return false;
        }

        $archive_path = $this->getWellFormattedArchivePath();

        if (!empty($archive_path)) {
            if(!is_dir($archive_path)) {
                $params['error'] = 'Non-existing archive path';
                return false;
            }
        } else {
            $params['error'] = 'Missing argument archive path';
            return false;
        }

        if (!empty($params['archive_prefix'])) {
            $archive_prefix = $params['archive_prefix'];
        } else {
            $params['error'] = 'Missing argument archive prefix';
            return false;
        }

        $ret_val         = null;
        $exec_res        = null;
        if (file_exists($source_path)) {
            $destination_path = $archive_path.$archive_prefix.'_'.basename($source_path);
            $cmd              = $this->archiveScript." ".$source_path." " .$destination_path;

            exec($cmd, $exec_res, $ret_val);
            if ($ret_val == 0) {

It seems like you are loosely comparing $ret_val of type integer|null to 0; this is ambiguous as not only 0 == 0 is true, but null == 0 is true, too. Consider using a strict comparison ===.

                $params['status'] = true;
                return true;
            } else {
                $params['error'] = 'Archiving of "'.$source_path.'" in "'.$destination_path.'" failed';
                return false;
            }
        } else {
            $params['error'] = 'Skipping file "'.$source_path.'": not found in file system.';
            return false;
        }
    }

    private function getWellFormattedArchivePath() {
        $archive_path = $this->getConfigurationParameter('archive_path');

        if ($archive_path) {
            $archive_path  = rtrim($archive_path, '/');
            $archive_path .= '/';
        }

        return $archive_path;
    }

}