system/plugins/habarisilo/habarisilo.plugin.php

<?php

namespace Habari;

if ( !defined( 'HABARI_PATH' ) ) { die( 'No direct access' ); }

class HabariSilo extends Plugin implements MediaSilo
{
  protected $root = null;
  protected $url = null;

  const SILO_NAME = 'Habari';

  const DERIV_DIR = '.deriv';

  public function action_init()
  {
    $user_path = HABARI_PATH . '/' . Site::get_path( 'user', true );
    $this->root = $user_path . 'files'; //Options::get('simple_file_root');
    $this->url = Site::get_url( 'user', true ) . 'files';  //Options::get('simple_file_url');
  }

  public function filter_activate_plugin( $ok, $file )
  {
    if ( Plugins::id_from_file( $file ) == Plugins::id_from_file( __FILE__ ) ) {
      if ( !$this->check_files() ) {
        EventLog::log( _t( "Habari Silo activation failed. The web server does not have permission to create the 'files' directory for the Habari Media Silo." ), 'warning', 'plugin' );
        Session::error( _t( "Habari Silo activation failed. The web server does not have permission to create the 'files' directory for the Habari Media Silo." ) );
        $ok = false;
      }
      // Don't bother loading if the gd library isn't active
      if ( !function_exists( 'imagecreatefromjpeg' ) ) {
        EventLog::log( _t( "Habari Silo activation failed. PHP has not loaded the gd imaging library." ), 'warning', 'plugin' );
        Session::error( _t( "Habari Silo activation failed. PHP has not loaded the gd imaging library." ) );
        $ok = false;
      }
    }
    return $ok;
  }

  public function action_plugin_activation( $file )
  {
    // Create required tokens
    ACL::create_token( 'create_directories', 'Create media silo directories', 'Administration' );
    ACL::create_token( 'delete_directories', 'Delete media silo directories', 'Administration' );
    ACL::create_token( 'upload_media', 'Upload files to media silos', 'Administration' );
    ACL::create_token( 'delete_media', 'Delete files from media silos', 'Administration' );
  }
  
  public function filter_plugin_config( $actions )
  {
    $actions['configure'] = _t('Configure');
    return $actions;
  }
  
  public function action_plugin_ui_configure()
  {
    $ui = new FormUI( strtolower( get_class( $this ) ) );
    $ui->append( FormControlLabel::wrap( _t('Max thumbnail width:'), FormControlText::create( 'max_thumbnail_width', __CLASS__ . '__max_thumbnail_width' ) ) );
    $ui->max_thumbnail_width->add_validator('validate_regex', '/^[0-9]*$/', _t('Only numbers may be entered for thumbnail width.'));
    $ui->append( FormControlLabel::wrap( _t('Max thumbnail height:'), FormControlText::create( 'max_thumbnail_height', __CLASS__ . '__max_thumbnail_height' ) ) );
    $ui->max_thumbnail_height->add_validator('validate_regex', '/^[0-9]*$/', _t('Only numbers may be entered for thumbnail height.'));
    $ui->append( FormControlLabel::wrap( _t('Always create square thumbnails (pad with black if not high enough):' ), FormControlCheckbox::create( 'force_square', __CLASS__ . '__force_square_thumbnail' ) ) );
    $ui->append(FormControlSubmit::create('save')->set_caption('Save'));
    $ui->out();
  }

  public function filter_token_description_display( $token )
  {
    $desc = array(
        'create_directories' => _t( 'Create media silo directories' ),
        'delete_directories' => _t( 'Delete media silo directories' ),
        'upload_media' => _t( 'Upload files to media silos' ),
        'delete_media' => _t( 'Delete files from media silos' ),
    );
    return isset( $desc[$token] ) ? $desc[$token] : $token;
  }

  public function action_plugin_deactivation( $file ) {
    $silos = Plugins::get_by_interface( 'MediaSilo' );
    if ( count( $silos ) <= 1 ) {
      ACL::destroy_token( 'upload_media' );
      ACL::destroy_token( 'delete_media' );
      ACL::destroy_token( 'create_directories' );
      ACL::destroy_token( 'delete_directories' );
    }
  }

  private function check_files() {
    $user_path = HABARI_PATH . '/' . Site::get_path( 'user', true );
    $this->root = $user_path . 'files'; //Options::get('simple_file_root');
    $this->url = Site::get_url( 'user', true ) . 'files';  //Options::get('simple_file_url');

    if ( !is_dir( $this->root ) ) {
      if ( is_writable( $user_path ) ) {
        mkdir( $this->root, 0755 );
      }
      else {
        return false;
      }
    }

    return true;
  }

  public function silo_info()
  {
    return array(
      'name' => self::SILO_NAME,
      'icon' => URL::get_from_filesystem( __FILE__ ) . '/icon.png'
    );
  }

  public function silo_dir( $path )
  {
    if ( !isset( $this->root ) ) {
      return array();
    }

    $path = preg_replace( '%\.{2,}%', '.', $path );
    $results = array();

    $dir = Utils::glob( $this->root . ( $path == '' ? '' : '/' ) . $path . '/*' );

    foreach ( $dir as $item ) {
      if ( substr( basename( $item ), 0, 1 ) == '.' ) {
        continue;
      }
      if ( basename( $item ) == 'desktop.ini' ) {
        continue;
      }

      $file = basename( $item );
      $props = array(
        'title' => basename( $item ),
      );
      if(is_dir($item)) {
        $results[] = new MediaAsset(
          self::SILO_NAME . '/' . $path . ($path == '' ? '' : '/') . basename( $item ),
          is_dir( $item ),
          $props
        );
      }
      else {
        $results[] = $this->silo_get( $path . ($path == '' ? '' : '/') . basename( $item ) );
      }
    }
    //print_r($results);
    return $results;
  }


  public function silo_get( $path, $qualities = null )
  {
    if ( ! isset( $this->root ) ) {
      return false;
    }

    $path = preg_replace( '%\.{2,}%', '.', $path );

    $file = basename( $path );
    $props = array(
      'title' => basename( $path ),
    );
    $realfile = $this->root . '/' . $path;

    $thumbnail_suffix = HabariSilo::DERIV_DIR . '/' . $file . '.thumbnail.jpg';
    $thumbnail_url = $this->url . '/' . dirname( $path ) . ( dirname( $path ) == '' ? '' : '/' ) . $thumbnail_suffix;
    $mimetype = preg_replace(' %[^a-z_0-9]%', '_', Utils::mimetype( $realfile ) );
    $mtime = '';

    if ( !file_exists( dirname( $realfile ) . '/' . $thumbnail_suffix ) ) {
      // Attempt to create thumbnail
      $max_thumbnail_width = Options::get( __CLASS__ . '__max_thumbnail_width', Media::THUMBNAIL_WIDTH );
      $max_thumbnail_height = Options::get( __CLASS__ . '__max_thumbnail_height', Media::THUMBNAIL_HEIGHT );
      if ( !$this->create_thumbnail( $realfile, $max_thumbnail_width, $max_thumbnail_height ) ) {
        // there is no thumbnail so use icon based on mimetype.
        $icon_path = Plugins::filter( 'habarisilo_icon_base_path', dirname( $this->get_file() ) . '/icons' );
        $icon_url = Plugins::filter( 'habarisilo_icon_base_url', $this->get_url() . '/icons' );

        if ( ( $icons = Utils::glob( $icon_path . '/*.{png,jpg,gif,svg}', GLOB_BRACE ) ) && $mimetype ) {
          $icon_keys = array_map( function($a) {return pathinfo($a, PATHINFO_FILENAME);}, $icons );
          $icons = array_combine( $icon_keys, $icons );
          $icon_filter = function($a, $b) use ($mimetype) {
            return (((strpos($mimetype, $a)===0) ? (strlen($a) / strlen($mimetype)) : 0) >= (((strpos($mimetype, $b)===0)) ? (strlen($b) / strlen($mimetype)) : 0)) ? $a : $b;
          };
          $icon_key = array_reduce( $icon_keys, $icon_filter );
          if ($icon_key) {
            $icon = basename( $icons[$icon_key] );
            $thumbnail_url = $icon_url .'/'. $icon;
          }
          else {
            // couldn't find an icon so use default
            $thumbnail_url = $icon_url .'/default.png';
          }
        } 
      }   
    }
        
    // If the asset is an image, obtain the image dimensions
    if ( in_array( $mimetype, array( 'image_jpeg', 'image_png', 'image_gif' ) ) ) {
      list( $props['width'], $props['height'] ) = getimagesize( $realfile );
      $mtime = '?' . filemtime( $realfile );
    }
    $props = array_merge(
      $props,
      array(
        'url' => $this->url . '/' . dirname( $path ) . ( $path == '' ? '' : '/' ) . $file,
        'thumbnail_url' => $thumbnail_url . $mtime,
        'filetype' => $mimetype,
      )
    );
    
    $asset = new MediaAsset( self::SILO_NAME . '/' . $path, false, $props );
    if ( file_exists( $realfile ) && is_file( $realfile ) ) {
      $asset->content = file_get_contents( $realfile );
    }
    return $asset;
  }


  private function create_thumbnail( $src_filename, $max_width = Media::THUMBNAIL_WIDTH, $max_height = Media::THUMBNAIL_HEIGHT )
  {
    // Does derivative directory not exist?
    $thumbdir = dirname( $src_filename ) . '/' . HabariSilo::DERIV_DIR . '';
    if ( !is_dir( $thumbdir ) ) {
      // Create the derivative driectory
      if ( !mkdir( $thumbdir, 0755 ) ) {
        // Couldn't make derivative directory
        return false;
      }
    }

    // Get information about the image
    $isize = @getimagesize( $src_filename );
    if(is_array($isize)) {
      list( $src_width, $src_height, $type, $attr )= $isize;
    }
    else {
      $type = '';
      $src_img = '';
    }

    // Load the image based on filetype
    switch ( $type ) {
    case IMAGETYPE_JPEG:
      $src_img = imagecreatefromjpeg( $src_filename );
      break;
    case IMAGETYPE_PNG:
      $src_img = imagecreatefrompng( $src_filename );
      break;
    case IMAGETYPE_GIF:
      $src_img = imagecreatefromgif ( $src_filename );
      break;
    default:
      return false;
    }
    // Did the image fail to load?
    if ( !$src_img ) {
      return false;
    }

    // Calculate the output size based on the original's aspect ratio
    $y_displacement = 0;
    $displace = Options::get( __CLASS__ . '__force_square_thumbnail', true );
    if ( $src_width / $src_height > $max_width / $max_height ) {
      $thumb_w = $max_width;
      $thumb_h = $src_height * $max_width / $src_width;

      if($displace) {
        // thumbnail is not full height, position it down so that it will be padded on the
        // top and bottom with black
        $y_displacement = ( $max_height - $thumb_h ) / 2;
      }
    }
    else {
      $thumb_w = $src_width * $max_height / $src_height;
      $thumb_h = $max_height;
    }

    // Create the output image and copy to source to it
    $dst_img = ImageCreateTrueColor( $thumb_w, ($displace) ? $max_height : $thumb_h );
    imagecopyresampled( $dst_img, $src_img, 0, $y_displacement, 0, 0, $thumb_w, $thumb_h, $src_width, $src_height );

    /* Sharpen before save?
    $sharpenMatrix= array( array(-1, -1, -1), array(-1, 16, -1), array(-1, -1, -1) );
    $divisor= 8;
    $offset= 0;
    imageconvolution( $dst_img, $sharpenMatrix, $divisor, $offset );
    //*/

    // Define the thumbnail filename
    $dst_filename = $thumbdir . '/' . basename( $src_filename ) . ".thumbnail.jpg";

    // Save the thumbnail as a JPEG
    imagejpeg( $dst_img, $dst_filename );

    // Clean up memory
    imagedestroy( $dst_img );
    imagedestroy( $src_img );

    return true;
  }

  public function silo_new( $path )
  {
  }

  public function silo_put( $path, $filedata )
  {
    $path = preg_replace('%\.{2,}%', '.', $path);
    $file = $this->root . '/' . $path;

    $result = $filedata->save( $file );
    if ( $result ) {
      $max_thumbnail_width = Options::get( __CLASS__ . '__max_thumbnail_width', Media::THUMBNAIL_WIDTH );
      $max_thumbnail_height = Options::get( __CLASS__ . '__max_thumbnail_height', Media::THUMBNAIL_HEIGHT );
      $this->create_thumbnail( $file, $max_thumbnail_width, $max_thumbnail_height );
    }

    return $result;
  }

  public function silo_delete( $path )
  {
    $file = $this->root . '/' . $path;

    // Delete the file
    $result = unlink( $file );

    // If it's an image, remove the file in .deriv too
    $thumbdir = dirname( $file ) . '/' . HabariSilo::DERIV_DIR . '';
    $thumb = $thumbdir . '/' . basename( $file ) . ".thumbnail.jpg";

    if ( file_exists( $thumbdir ) && file_exists( $thumb ) ) {
      unlink( $thumb );
      // if this is the last thumb, delete the .deriv dir too
      if ( self::isEmptyDir( $thumbdir ) ) {
        rmdir( $thumbdir );
      }
    }
    return $result;
  }

  public function silo_highlights()
  {
  }

  public function silo_permissions( $path )
  {
  }

  public function link_path( $path, $title = '' )
  {
    if ( $title == '' ) {
      $title = basename( $path );
    }
    return '<a href="#" onclick="habari.media.showdir(\''.$path.'\');return false;">' . $title . '</a>';
  }

  public function link_panel( $path, $panel, $title )
  {
    return '<a href="#" onclick="habari.media.showpanel(\''.$path.'\', \''.$panel.'\');return false;">' . $title . '</a>';
  }

  public function filter_media_controls( $controls, $silo, $path, $panelname )
  {
    $class = __CLASS__;
    if ( $silo instanceof $class ) {
      $controls[] = $this->link_path( self::SILO_NAME . '/' . $path, _t( 'Browse' ) );
      if ( User::identify()->can( 'upload_media' ) ) {
        $controls[] = $this->link_panel( self::SILO_NAME . '/' . $path, 'upload', _t( 'Upload' ) );
      }
      if ( User::identify()->can( 'create_directories' ) ) {
        $controls[] = $this->link_panel( self::SILO_NAME . '/' . $path, 'mkdir', _t( 'Create Directory' ) );
      }
      if ( User::identify()->can( 'delete_directories' ) && ( $path && self::isEmptyDir( $this->root . '/' . $path ) ) ) {
        $controls[] = $this->link_panel( self::SILO_NAME . '/' . $path, 'rmdir', _t( 'Delete Directory' ) );
      }
    }
    return $controls;
  }

  public function filter_media_panels( $panel, $silo, $path, $panelname)
  {
    $class = __CLASS__;
    if ( $silo instanceof $class ) {
      switch ( $panelname ) {
        case 'mkdir':

          $fullpath = self::SILO_NAME . '/' . $path;

          $form = new FormUI( 'habarisilomkdir' );
          $form->append( FormControlStatic::create( 'ParentDirectory' )->set_static( '<div style="margin: 10px auto;">' . _t( 'Parent Directory:' ) . " <strong>/{$path}</strong></div>" ) );
          // add the parent directory as a hidden input for later validation
          $form->append( FormControlData::create( 'path' )->set_value( $path ) );
          $form->append( FormControlData::create( 'action' )->set_value( $panelname ) );

          $form->append( FormControlLabel::wrap( _t('What would you like to call the new directory?'), 
            FormControlText::create( 'directory' )->add_validator( array( $this, 'mkdir_validator' ) ) ) );
          $form->append( FormControlSubmit::create( 'submit' )->set_caption( _t('Submit') ) );
          $form->media_panel($fullpath, $panelname, 'habari.media.forceReload();');
          $form->on_success( array( $this, 'dir_success' ) );
          $panel = $form->get(); /* form submission magicallly happens here */

          return $panel;

          break;
        case 'rmdir':
          $fullpath = self::SILO_NAME . '/' . $path;

          $form = new FormUI( 'habarisilormdir' );
          $form->append( FormControlStatic::create( 'RmDirectory' )->set_static( '<div style="margin: 10px auto;">' . _t( 'Directory:' ) . " <strong>/{$path}</strong></div>" ) );
          // add the parent directory as a hidden input for later validation
          $form->append( FormControlData::create( 'path')->set_value( $path ) );
          $form->append( FormControlData::create( 'action' )->set_value( $panelname ) );
          $form->append( FormControlStatic::create( 'directory' )->set_static( _t( 'Are you sure you want to delete this directory?' ) ) );
          $form->append( FormControlSubmit::create( 'submit' )->set_caption( _t('Delete') ) );
          $form->media_panel( $fullpath, $panelname, 'habari.media.forceReload();' );
          $form->on_success( array( $this, 'dir_success' ) );
          $panel = $form->get(); /* form submission magicallly happens here */

          return $panel;

          break;
        case 'delete':
          $fullpath = self::SILO_NAME . '/' . $path;

          $form = new FormUI( 'habarisilodelete' );
          $form->append( FormControlStatic::create( 'RmFile' )->set_static( '<div style="margin: 10px auto;">' . _t( 'File:' ) . " <strong>/{$path}</strong></div>" ) );
          // add the parent directory as a hidden input for later validation
          $form->append( FormControlData::create( 'path')->set_value( $path ) );
          $form->append( FormControlStatic::create( 'directory' )->set_static( '<p>' . _t( 'Are you sure you want to delete this file?' ) . '</p>' ) );
          $form->append( FormControlSubmit::create( 'submit' )->set_caption( _t('Delete') ) );
          $form->media_panel( $fullpath, $panelname, 'habari.media.forceReload();' );
          $form->on_success( array( $this, 'do_delete' ) );
          $panel = $form->get(); /* form submission magicallly happens here */

          return $panel;
          break;
        case 'upload':
          if ( isset( $_FILES['file'] ) ) {
            if ( isset( $_POST['token'] ) && isset( $_POST['token_ts'] ) && self::verify_token( $_POST['token'], $_POST['token_ts'] ) ) {
              $size = Utils::human_size( $_FILES['file']['size'] );
              $panel .= '<div class="span-18" style="padding-top:30px;color: #e0e0e0;margin: 0px auto;"><p>' . _t( 'File: ' ) . $_FILES['file']['name'];
              $panel .= ( $_FILES['file']['size'] > 0 ) ? "({$size})" : '';
              $panel .= '</p>';

              $path = self::SILO_NAME . '/' . preg_replace( '%\.{2,}%', '.', $path ). '/' . $_FILES['file']['name'];
              $asset = new MediaAsset( $path, false );
              $asset->upload( $_FILES['file'] );

              if ( $asset->put() ) {
                $msg = _t( 'File uploaded: %s', array( $_FILES['file']['name'] ) );
                $panel .= '<p>' . $msg . '</p>';
                EventLog::log( $msg, 'info' );
              }
              else {
                $upload_errors = array(
                    1 => _t( 'The uploaded file exceeds the upload_max_filesize directive in php.ini.' ),
                    2 => _t( 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.' ),
                    3 => _t( 'The uploaded file was only partially uploaded.' ),
                    4 => _t( 'No file was uploaded.' ),
                    6 => _t( 'Missing a temporary folder.' ),
                    7 => _t( 'Failed to write file to disk.' ),
                    8 => _t( 'A PHP extension stopped the file upload. PHP does not provide a way to ascertain which extension caused the file upload to stop; examining the list of loaded extensions with phpinfo() may help.' ),
                  );
                $msg = _t( 'File upload failed: %s', array( $_FILES['file']['name'] ) );
                $panel .= '<p>' . $msg . '</p>';
                $panel .= '<p><strong>' . $upload_errors[ $_FILES['file']['error'] ] . '</strong></p>';
                EventLog::log( $msg . ' ' . $upload_errors[ $_FILES['file']['error'] ], 'err' );
              }

              $panel .= '<p><a href="#" onclick="habari.media.forceReload();habari.media.showdir(\'' . dirname( $path ) . '\');">' . _t( 'Browse the current silo path.' ) . '</a></p></div>';
            } else {
              $panel .= '<p><strong>' ._t( 'Suspicious behaviour or too much time has elapsed.  Please upload your file again.' ) . '</strong></p>';
            }
          }
          else {
            $token_ts = time();
            $token = self::create_token( $token_ts );
            $fullpath = self::SILO_NAME . '/' . $path;
            $form_action = URL::get( 'admin_ajax', array( 'context' => 'media_upload' ) );
            $panel .= <<< UPLOAD_FORM
<form enctype="multipart/form-data" method="post" id="simple_upload" target="simple_upload_frame" action="{$form_action}" class="span-10" style="margin:0px auto;text-align: center">
  <p style="padding-top:30px;">%s <b style="font-weight:normal;color: #e0e0e0;font-size: 1.2em;">/{$path}</b></p>
  <p><input type="file" name="file"><input type="submit" name="upload" value="%s">
  <input type="hidden" name="path" value="{$fullpath}">
  <input type="hidden" name="panel" value="{$panelname}">
  <input type="hidden" name="token" value="{$token}">
  <input type="hidden" name="token_ts" value="{$token_ts}">
  </p>
</form>
<iframe id="simple_upload_frame" name="simple_upload_frame" style="width:1px;height:1px;" onload="simple_uploaded();"></iframe>
<script type="text/javascript">
var responsedata;
function simple_uploaded() {
  if (!$('#simple_upload_frame')[0].contentWindow) return;
  var response = $($('#simple_upload_frame')[0].contentWindow.document.body).text();
  if (response) {
    eval('responsedata = ' + response);
    window.setTimeout(simple_uploaded_complete, 500);
  }
}
function simple_uploaded_complete() {
  habari.media.jsonpanel(responsedata.data);
}
</script>
UPLOAD_FORM;

          $panel = sprintf( $panel, _t( "Upload to:" ), _t( "Upload" ) );
        }
      }
    }
    return $panel;
  }

  public function mkdir_validator( $dir, $control, $form )
  {
    if ( strpos( $dir, '*' ) !== false || preg_match( '%(?:^|/)\.%', $dir ) ) {
        return array( _t( "The directory name contains invalid characters: %s.", array( $dir ) ) );
    }

    $path = preg_replace( '%\.{2,}%', '.', $form->path->value );
    $dir = $this->root . ( $path == '' ? '' : '/' ) . $path . '/'. $dir;

    if ( !is_writable( $this->root . '/' . $path ) ) {
      return array( _t( "Webserver does not have permission to create directory: %s.", array( $dir ) ) );
    }
    if ( is_dir( $dir ) ) {
      return array( _t( "Directory: %s already exists.", array( $dir ) ) );
    }

    return array();
  }
  public function dir_success ( $form )
  {
    $dir = preg_replace( '%\.{2,}%', '.', $form->directory->value );
    $path = preg_replace( '%\.{2,}%', '.', $form->path->value );

    switch ( $form->action->value ) {
      case 'rmdir':
        $dir = $this->root . ( $path == '' ? '' : '/' ) . $path;
        rmdir( $dir );
        $msg = _t( 'Directory deleted: /%s', array( $path ) );
        break;
      case 'mkdir':
        $dir = $this->root . ( $path == '' ? '' : '/' ) . $path . '/'. $dir;
        mkdir( $dir, 0755 );
        $msg = _t ( 'Directory created: %s', array( $path . '/' . $form->directory->value ) );
        break;
    }
    EventLog::log( $msg, 'info' );
    return '<div class="span-18"style="padding-top:30px;color: #e0e0e0;margin: 0px auto;"><p>' . $msg . '</p></div>';
  }

  public function do_delete ( $form )
  {
    $path = preg_replace( '%\.{2,}%', '.', $form->path->value );
    $result = $this->silo_delete($path);
    $panel = '<div class="span-18"style="padding-top:30px;color: #e0e0e0;margin: 0px auto;">';
    if ( $result ) {
      $msg = _t( 'File deleted: /%s', array( $path ) );
    } else {
      $msg = _t( 'Failed to delete file: /%s', array( $path ) );
    }
    $panel .= '<p>' . $msg . '</p>';
    $panel .= '<p><a href="#" onclick="habari.media.forceReload();habari.media.showdir(\'' . self::SILO_NAME . '/' . dirname( $path ) . '\');">' . _t( 'Browse the current silo path.' ) . '</a></p></div>';

    EventLog::log( $msg, 'info' );
    return $panel;
  }

  private static function isEmptyDir( $dir )
  {
    return ( ( $files = @scandir( $dir ) ) && count( $files ) <= 2 );
  }

  private static function create_token( $timestamp )
  {
    return substr( md5( $timestamp . Options::get( 'public-GUID' ) ), 0, 10 );
  }

  private static function verify_token( $token, $timestamp )
  {
    if ( $token == self::create_token( $timestamp ) ) {
      if ( ( time() > ( $timestamp ) ) && ( time() < ( $timestamp + 5*60 ) ) ) {
        return true;
      }
    } else {
      return false;
    }
  }

}

?>