class.ResourceListController.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for
 * additional information.
 *
 * $Id: class.ResourceListController.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/presentation/class.Controller.php");
require_once(BASE."wcmf/lib/util/class.URIUtil.php");
require_once(BASE."wcmf/lib/util/class.GraphicsUtil.php");

include_once(BASE."wcmf/3rdparty/elfinder/php/elFinderConnector.class.php");
include_once(BASE."wcmf/3rdparty/elfinder/php/elFinder.class.php");
include_once(BASE."wcmf/3rdparty/elfinder/php/elFinderVolumeDriver.class.php");
include_once(BASE."wcmf/3rdparty/elfinder/php/elFinderVolumeLocalFileSystem.class.php");

/**
 * @class ResourceListController
 * @ingroup Controller
 * @brief ResourceListController is a controller used to manage resources from the
 * server and displays it using the resourcelist.tpl template. For file resources
 * it uses elFinder.
 *
 * <b>Input actions:</b>
 * - unspecified: List all resources in the given directory
 *
 * <b>Output actions:</b>
 * - @em ok In any case
 *
 * @param[in] directory The name of the directory to scan for resources (optinal, if not given the directory is
 *            retrieved using the ResourceListController::getResourceBaseDir() method).
 * @param[in,out] type The main resource type to list (e.g. link or image, default is image if not given).
 * @param[in,out] subtype The sub resource type to list (e.g. content or resource, default is resource if not given).
 * @param[in,out] fieldName The name of the input field to set the resource value to.
 * @param[out] rootPath The base path for resources.
 * @param[out] rootUrl The root url for resources.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class ResourceListController extends Controller
{
  // session name constants
  var $DIRECTORY_VARNAME = 'ResourceListController.directory';

  // the resource directory
  var $_directory;

  /**
   * @see Controller::initialize()
   */
  function initialize(&$request, &$response)
  {
    parent::initialize($request, $response);

    $baseDir = $this->getResourceBaseDir();

    // default directory is base dir
    $this->_directory = $baseDir;

    // try to get a formerly selected directory from the session
        $session = &SessionData::getInstance();
    if ($session->exist($this->DIRECTORY_VARNAME)) {
      $this->_directory = $session->get($this->DIRECTORY_VARNAME);
    }

    // allow to override the directory with a request parameter
    if ($request->hasValue('directory') && strpos($request->getValue('directory'), $baseDir) === 0) {
      $this->_directory = $request->getValue('directory');
    }

    // store the directory in the session
    $session->set($this->DIRECTORY_VARNAME, $this->_directory);
  }

  /**
   * @see Controller::hasView()
   */
  function hasView()
  {
    if (in_array($this->_request->getAction(), array("browseresources", "crop"))) {
      return true;
    }
    else {
      return false;
    }
  }

  /**
   * Process finder actions.
   * @return True in every case.
   * @see Controller::executeKernel()
   */
  function executeKernel()
  {
    // get root path and root url for the browser
    $rootPath = $this->getResourceBaseDir();
    $refURL = URIUtil::getProtocolStr().$_SERVER['HTTP_HOST'].$_SERVER['SCRIPT_NAME'];
    $rootUrl = URIUtil::makeAbsolute($rootPath, $refURL);

    // set common response values
    if ($this->_request->hasValue('fieldName')) {
      $this->_response->setValue('fieldName', $this->_request->getValue('fieldName'));
    }
    $this->_response->setValue('rootUrl', $rootUrl);
    $this->_response->setValue('rootPath', $rootPath);
    $this->_response->setValue('type', $this->_request->getValue('type', 'image'));
    $this->_response->setValue('subtype', $this->_request->getValue('subtype', 'resource'));
    $this->_response->setValue('CKEditorFuncNum', $this->_request->getValue('CKEditorFuncNum'));

    if (!in_array($this->_request->getAction(), array("browseresources", "crop"))) {
      $opts = array(
        // 'debug' => true,
        'roots' => array(
          array(
            'driver' => 'LocalFileSystem', // driver for accessing file system (REQUIRED)
            'path' => $rootPath,           // path to files (REQUIRED)
            'URL' => $rootUrl,             // URL to files (REQUIRED)
            'alias' => 'Media',
            'startPath' => $this->_directory
          )
        ),
        'bind' => array(
          'rename rm paste' => array($this, 'onFileMoved')
        ),
      );

      // run elFinder
      $connector = new elFinderConnector(new elFinder($opts));
      $connector->run();

      $this->_response->setAction('ok');
      return true;
    }
    else {
      // custom crop action
      if ($this->_request->getAction() == 'crop') {
        $file = $this->_request->getValue('oid');
        $this->_response->setValue('oid', $file);
        if ($this->_request->hasValue('cropX') && $this->_request->hasValue('cropY') &&
                $this->_request->hasValue('cropWidth') && $this->_request->hasValue('cropHeight')) {
          // extract crop info
          $x = $this->_request->getValue('cropX');
          $y = $this->_request->getValue('cropY');
          $w = $this->_request->getValue('cropWidth');
          $h = $this->_request->getValue('cropHeight');

          // define target file name
          $cropInfo = 'x'.$x.'y'.$y.'w'.$w.'h'.$h;
          $pathParts = pathinfo($file);
          $targetFile = $pathParts['dirname'].'/'.$pathParts['filename'].'_'.$cropInfo.'.'.$pathParts['extension'];

          // crop the image
          $graphicsUtil = new GraphicsUtil();
          $graphicsUtil->cropImage($file, $targetFile, $w, $h, $x, $y);
          $this->_response->setValue('fieldName', $this->_request->getValue('fieldName'));
          $this->_response->setAction('browseresources');
          return true;
        }
      }

      $this->_response->setAction('ok');
      return false;
    }
  }

  /**
   * Called when file is moved
   * @param  cmd elFinder command name
   * @param  result Command result as array
   * @param  args Command arguments from client
   * @param  elfinder elFinder instance
   * @return void|true
  **/
  function onFileMoved($cmd, $result, $args, $elfinder)
  {
    $addedFiles = $result['added'];
    $removedFiles = $result['removed'];
    for ($i=0, $count=sizeof($removedFiles); $i<$count; $i++) {
      $source = $removedFiles[$i]['realpath'];
      $target = $elfinder->realpath($addedFiles[$i]['hash']);
    }
    Log::debug($cmd." file: ".$source." -> ".$target, __CLASS__);
  }


  /**
   * Get the base directory for resources. The default implementation
   * returns the directory configured by the 'uploadDir' key in section 'media'.
   * @return The directory name
   * @note Subclasses will override this method to implement special application requirements
   */
  function getResourceBaseDir()
  {
    $parser = &InifileParser::getInstance();
    if(($uploadDir = $parser->getValue('uploadDir', 'media')) !== false)
    {
      // remove slash if nescessary
      if (substr($uploadDir, -1) == '/')
        $uploadDir = substr($uploadDir, 0, -1);

      return $uploadDir;
    }
    return '';
  }
}
?>