tao-test/app/taoItems/helpers/class.Deployment.php

<?php
/*
 * This program 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; under version 2
 * of the License (non-upgradable).
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
 *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
 *               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
 *
 */

/**
 * Helper for the deployment of items
 *
 * @access public
 * @author Bout Joel, <joel@taotesting.com>
 * @package taoItems

 */
class taoItems_helpers_Deployment
{

    private static $defaultMedia = ["jpg", "jpeg", "png", "gif", "mp3", 'mp4', 'webm', 'swf', 'wma', 'wav', 'css', 'js'];

    /**
     * Copy the resources from one directory to another
     *
     * @param string $sourceDirectory
     * @param string $destinationDirectory
     * @param array $excludeFiles
     * @return boolean
     */
    public static function copyResources($sourceDirectory, $destinationDirectory, $excludeFiles = [])
    {
        //copy the resources
        $exclude = array_merge($excludeFiles, ['.', '..', '.svn']);
        $success = true;
        foreach (scandir($sourceDirectory) as $file) {
            if (!in_array($file, $exclude)) {
                $success &= tao_helpers_File::copy(
                    $sourceDirectory . $file,
                    $destinationDirectory . $file,
                    true
                );
            }
        }
        return $success;
    }

    /**
     *
     * @param unknown $xhtml
     * @param unknown $destination
     * @return common_report_Report
     */
    public static function retrieveExternalResources($xhtml, $destination)
    {
        
        if (!file_exists($destination)) {
            if (!mkdir($destination)) {
                common_Logger::e('Folder ' . $destination . ' could not be created');
                return new common_report_Report(
                    common_report_Report::TYPE_ERROR,
                    __('Unable to create deployement directory'),
                    $xhtml
                );
            }
        }

        $authorizedMedia = self::$defaultMedia;

        $mediaList = [];
        $expr = "/http[s]?:(\\\\)?\/(\\\\)?\/[^<'\"&?]+\.(" . implode('|', $authorizedMedia) . ")/mi";//take into account json encoded url
        preg_match_all($expr, $xhtml, $mediaList, PREG_PATTERN_ORDER);

        $uniqueMediaList = array_unique($mediaList[0]);

        $report = new common_report_Report(common_report_Report::TYPE_SUCCESS, __('Retrieving external resources'));
        
        foreach ($uniqueMediaList as $mediaUrl) {
            // This is a file that has to be stored in the item compilation folder itself...
            // I do not get why they are all copied. They are all there they were copied from the item module...
            // But I agree that remote resources (somewhere on the Internet) should be copied via curl.
            // So if the URL does not matches a place where the TAO server is, we curl the resource and store it.
            // FileManager files should be considered as remote resources to avoid 404 issues. Indeed, a backoffice
            // user might delete an image in the filemanager during a delivery campain. This is dangerous.
            
            $decodedMediaUrl = str_replace('\/', '/', $mediaUrl);
            
            $mediaPath = self::retrieveFile($decodedMediaUrl, $destination);
            if (!empty($mediaPath) && $mediaPath !== false) {
                $xhtml = str_replace($mediaUrl, basename($mediaPath), $xhtml, $replaced); //replace only when copyFile is successful
            } else {
                $report->add(new common_report_Report(common_report_Report::TYPE_ERROR, __('Failed retrieving %s', $decodedMediaUrl)));
                $report->setType(common_report_Report::TYPE_ERROR);
            }
        }
        if ($report->getType() == common_report_Report::TYPE_SUCCESS) {
            $report->setData($xhtml);
        }
        return $report;
    }

    /**
     * Retrieve a file from a given $url and copy it to its final $destination.
     *
     * @param string $url The URL to be dereferenced.
     * @param string $destination The destination of the retrieved file, on the file system.
     * @return boolean|string false If an error occurs during the retrieval/copy process, or the final destination name if it succeeds.
     */
    public static function retrieveFile($url, $destination)
    {

        $fileName = basename($url);
        //check file name compatibility:
        //e.g. if a file with a common name (e.g. car.jpg, house.png, sound.mp3) already exists in the destination folder
        while (file_exists($destination . $fileName)) {
            $lastDot = strrpos($fileName, '.');
            $fileName = substr($fileName, 0, $lastDot) . '_' . substr($fileName, $lastDot);
        }

        // Since the file has not been downloaded yet, start downloading it using cUrl
        // Only if the resource is external, else we copy it
        if (!preg_match('@^' . ROOT_URL . '@', $url)) {
            common_Logger::d('Downloading ' . $url);
            helpers_TimeOutHelper::setTimeOutLimit(helpers_TimeOutHelper::NO_TIMEOUT);
            $fp = fopen($destination . $fileName, 'w+');
            $curlHandler = curl_init();
            curl_setopt($curlHandler, CURLOPT_URL, $url);
            curl_setopt($curlHandler, CURLOPT_FILE, $fp);
            curl_setopt($curlHandler, CURLOPT_TIMEOUT, 50);
            curl_setopt($curlHandler, CURLOPT_FOLLOWLOCATION, true);

            //if there is an http auth on the local domain, it's mandatory to auth with curl
            if (USE_HTTP_AUTH) {
                $addAuth = false;
                $domains = ['localhost', '127.0.0.1', ROOT_URL];
                
                foreach ($domains as $domain) {
                    if (preg_match("/" . preg_quote($domain, '/') . "/", $url)) {
                        $addAuth = true;
                    }
                }
                
                if ($addAuth) {
                    curl_setopt($curlHandler, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
                    curl_setopt($curlHandler, CURLOPT_USERPWD, USE_HTTP_USER . ":" . USE_HTTP_PASS);
                }
            }
            
            curl_exec($curlHandler);
            $httpCode = curl_getinfo($curlHandler, CURLINFO_HTTP_CODE);
            $success = $httpCode == 200;
            curl_close($curlHandler);
            fclose($fp);
            helpers_TimeOutHelper::reset();
        } else {
            $path = tao_helpers_File::getPathFromUrl($url);
            common_Logger::d('Copying ' . $path);
            $success = helpers_File::copy($path, $destination . $fileName);
        }
        
        if ($success == false) {
            common_Logger::w('Unable to retrieve ' . $url);
            return false;
        } else {
            return $destination . $fileName;
        }
    }
}