Changeset 602441

Timestamp:

09/22/2012 05:53:34 PM (14 years ago)

Author:

ti2m

Message:

Filesystem usage changes

Location:

edge-suite/trunk

Files:

• admin/manage.php (modified) (2 diffs)
• admin/options.php (modified) (3 diffs)
• edge-suite.php (modified) (5 diffs)
• includes/edge-suite-comp-builder.inc (modified) (3 diffs)
• includes/edge-suite-comp.inc (modified) (3 diffs)
• includes/edge-suite-general.php (modified) (3 diffs)
• readme.txt (modified) (4 diffs)

edge-suite/trunk/admin/manage.php

@@ -58 +58 @@
 
     // Init file system
-    WP_Filesystem();
+    // Todo: this doesn't work with FTP
+    //WP_Filesystem();
 
     $tmp_file = EDGE_SUITE_PUBLIC_DIR . '/tmp/' . $_FILES['edge_suite_composition_upload']['name'];
@@ -93 +94 @@
   <h2>Edge Suite - Manage compositions</h2>
 
+  <?php
+  $msg = check_filesystem();
+    if(!empty($msg)){
+      echo '<div class="error"><p>';
+      echo implode('</br>',$msg);
+      echo '</p></div>';
+    }
+  ?>
 
-  <h3>Upload new composition</h3>
+<h3>Upload new composition</h3>
 <form enctype="multipart/form-data" action="<?php echo $_SERVER["REQUEST_URI"]; ?>" method="POST">
   <input name="edge_suite_composition_upload" type="file" />

edge-suite/trunk/admin/options.php

@@ -6 +6 @@
     <?php settings_fields('edge_suite_options'); ?>
     <table class="form-table">
-
-      <tr valign="top">
-        <th scope="row">Max upload file size</th>
-        <td>
-          <input type="text" name="edge_suite_max_size"
-                 value="<?php echo get_option('edge_suite_max_size'); ?>"/>
-          <span class="setting-description">
-            File size in MB<br/>This is the max size that your file uploads will be limited to. 2 MB is the default upload size.
-          </span>
-        </td>
-      </tr>
-
 
       <tr valign="top">
@@ -48 +36 @@
       </tr>
 
+      <tr valign="top">
+          <th scope="row">Max upload file size</th>
+          <td>
+              <input type="text" name="edge_suite_max_size"
+                     value="<?php echo intval(get_option('edge_suite_max_size')); ?>"/>
+        <span class="setting-description">
+          File size in MB<br/>This is the max size that your file uploads will be limited to. 2 MB is the default upload size.
+        </span>
+          </td>
+      </tr>
+
+      <tr valign="top">
+          <th scope="row">Deactivation deletion</th>
+          <td>
+            <?php
+            $selected = intval(get_option('edge_suite_deactivation_delete')) == 1 ? 'checked="checked"' : '';
+            ?>
+            <p><input type="checkbox" name="edge_suite_deactivation_delete" value="1" <?php echo $selected; ?>"/>
+                Delete Edge Suite assets and settings on plugin deactivation</p>
+            <span class="setting-description">
+              Activate this option to delete all uploaded compositions (files and database entries) including all Edge Suite
+              settings from wordpress when deactivating the plugin. This should be activated if you are unable to delete files
+              manually through FTP and want to clean out Edge Suite completely.
+            </span>
+          </td>
+      </tr>
+
 
     </table>
@@ -53 +68 @@
     <input type="hidden" name="action" value="update"/>
     <input type="hidden" name="page_options"
-           value="edge_suite_max_size,edge_suite_comp_default,edge_suite_comp_homepage"/>
+           value="edge_suite_max_size,edge_suite_comp_default,edge_suite_comp_homepage,edge_suite_deactivation_delete"/>
 
     <p class="submit">

edge-suite/trunk/edge-suite.php

@@ -2 +2 @@
 /*
 Plugin Name: Edge Suite
-Plugin URI: http://timm-jansen.net/edge_suite_wp
+Plugin URI: http://edgedocks.com/edge_suite
 Description: Upload Adobe Edge compositions to your website.
 Author: Timm Jansen
 Author URI: http://timm-jansen.net/
-Version: 0.1
+Version: 0.2
 */
 
@@ -28 +28 @@
 /**
  * This is a port of the Drupal Edge Suite module (done by me as well) for wordpress.
- */
+*/
 
 require_once('includes/edge-suite-general.php');
 require_once('includes/edge-suite-comp.inc');
+
+/**
+ * Set all needed constants
+ */
+function edge_suite_init_constants(){
+  // Respect general upload path.
+  $upload_dir = get_option('upload_path');
+  if (empty($upload_dir)) {
+    $upload_dir = 'wp-content/uploads';
+  }
+  $upload_dir = untrailingslashit($upload_dir);
+
+  define('EDGE_SUITE_PUBLIC_DIR_REL', get_bloginfo('wpurl') . '/' . $upload_dir . '/edge_suite');
+  define('EDGE_SUITE_PUBLIC_DIR', untrailingslashit(ABSPATH) . '/' . $upload_dir . '/edge_suite');
+
+  define('EDGE_SUITE_COMP_PROJECT_DIR', EDGE_SUITE_PUBLIC_DIR . '/project');
+  define('EDGE_SUITE_COMP_PROJECT_DIR_REL', EDGE_SUITE_PUBLIC_DIR_REL . '/project');
+
+
+  define('EDGE_SUITE_ALLOWED_ASSET_EXTENSIONS', 'js|png|jpg|gif|svg|css');
+
+
+  define('REQUEST_TIME', time());
+
+}
 
 /*** UN/INSTALL ***/
@@ -61 +86 @@
   // Default options.
   add_option('edge_suite_max_size', 2);
-  add_option('edge_suite_comp_default', 0);
+  add_option('edge_suite_comp_default', -1);
   add_option('edge_suite_comp_homepage', 0);
+  add_option('edge_suite_deactivation_delete', 0);
+
+  // Create main edge suite directory.
+  mkdir_recursive(trailingslashit(EDGE_SUITE_PUBLIC_DIR));
 }
 
@@ -69 +98 @@
 
 function edge_suite_uninstall() {
-  global $wpdb;
-  $table_name = $wpdb->prefix . "edge_suite_composition_definition";
-  if ($wpdb->get_var("show tables like '$table_name'") == $table_name) {
-    $wpdb->query('DROP TABLE ' . $table_name);
-  }
-  // Todo: Delete all edge directories / options / meta data?
+  if(get_option('edge_suite_deactivation_delete') == 1){
+    edge_suite_init_constants();
+
+    global $wpdb;
+    $table_name = $wpdb->prefix . "edge_suite_composition_definition";
+    if ($wpdb->get_var("show tables like '$table_name'") == $table_name) {
+      $wpdb->query('DROP TABLE ' . $table_name);
+    }
+
+    // Delete all edge directories
+    rmdir_recursive(trailingslashit(EDGE_SUITE_PUBLIC_DIR));
+
+    // Delete options
+    delete_option('edge_suite_max_size');
+    delete_option('edge_suite_comp_default');
+    delete_option('edge_suite_comp_homepage');
+    delete_option('edge_suite_deactivation_delete');
+  }
 }
 
 register_deactivation_hook(__FILE__, 'edge_suite_uninstall');
-
-
-/**
- * Register general options.
- */
+//register_uninstall_hook(__FILE__, 'edge_suite_uninstall');
+
+
+/**
+* Register general options.
+*/
 function edge_suite_options_init() {
   register_setting('edge_suite_options', 'edge_suite_max_size');
   register_setting('edge_suite_options', 'edge_suite_comp_default');
   register_setting('edge_suite_options', 'edge_suite_comp_homepage');
+  register_setting('edge_suite_options', 'edge_suite_deactivation_delete');
 }
 
 add_action('admin_init', 'edge_suite_options_init');
+
 
 
@@ -101 +145 @@
   $edge_suite->msg = array();
 
-  // Respect general upload path.
-  $upload_dir = get_option('upload_path');
-  if (empty($upload_dir)) {
-    $upload_dir = 'wp-content/uploads';
-  }
-
-  define('EDGE_SUITE_PUBLIC_DIR_REL', get_bloginfo('wpurl') . '/' . $upload_dir . '/edge_suite');
-  define('EDGE_SUITE_PUBLIC_DIR', ABSPATH . '/' . $upload_dir . '/edge_suite');
-
-  define('EDGE_SUITE_COMP_PROJECT_DIR', EDGE_SUITE_PUBLIC_DIR . '/project');
-  define('EDGE_SUITE_COMP_PROJECT_DIR_REL', EDGE_SUITE_PUBLIC_DIR_REL . '/project');
+  edge_suite_init_constants();
 
   //Check if dir is writable and create directory structure.
   if (!mkdir_recursive(EDGE_SUITE_COMP_PROJECT_DIR)) {
-    $message = sprintf(__('Unable to create directory %s. Is its parent directory writable by the server?'), EDGE_SUITE_COMP_PROJECT_DIR_REL);
-    return array('error' => $message);
-  }
-
-  define('REQUEST_TIME', time());
+    print sprintf(__('Unable to create directory %s. Is its parent directory writable by the server?'), EDGE_SUITE_COMP_PROJECT_DIR_REL);
+  }
+
 }
 

edge-suite/trunk/includes/edge-suite-comp-builder.inc

@@ -325 +325 @@
 
     // Get archiver.
-    $success = unzip_file($file, $destination);
-    if (!$success) {
-      throw new Exception('Extraction of ' . $file . 'failed.');
+    $success = unzip($file, $destination);
+    if (is_wp_error($success)) {
+      throw new Exception('Extraction of ' . $file . ' failed.');
     }
   }
@@ -535 +535 @@
 
         if ($overwrite || !$exists) {
-          $moved = $wp_filesystem->move($lib->uri, $this->edgeDir . '/edge_includes/' . $lib->filename, TRUE);
+          $moved = move_file($lib->uri, $this->edgeDir . '/edge_includes/' . $lib->filename);
           if (!$moved) {
             set_message('Library ' . check_plain($lib->filename) . ' could not be added/moved.');
@@ -604 +604 @@
       // TODO: Feedback if file couldn't be moved.
       $file_info = pathinfo($f);
-      $moved = $wp_filesystem->move($f, $dest . '/' . $rel_dir . '/' . $file_info['basename']);
+      $moved = move_file($f, $dest . '/' . $rel_dir . '/' . $file_info['basename']);
     }
   }

edge-suite/trunk/includes/edge-suite-comp.inc

@@ -89 +89 @@
 
       $project_path = EDGE_SUITE_COMP_PROJECT_DIR . '/' . $def_name;
-      rename($project_tmp_path, $project_path);
+      move_file($project_tmp_path, $project_path);
 
       $success = TRUE;
@@ -95 +95 @@
   } catch (Exception $e) {
     // Clean out all files.
-    print $e->getMessage();
 
     // Make sure source extraction directory gets cleaned out.
@@ -107 +106 @@
       rmdir_recursive($project_path);
     }
+
+    // Hand exception to the next level.
+    throw new Exception($e->getMessage());
     // TODO: Libraries might have been copied. Critical?
   }

edge-suite/trunk/includes/edge-suite-general.php

@@ -1 +1 @@
 <?php
 
+
+
+// Not used yet
+function fs_connect( $directories = array() ) {
+  global $wp_filesystem;
+
+  $url = "edge_suite";
+  if ( false === ($credentials = request_filesystem_credentials($url)) )
+    return false;
+
+  if ( ! WP_Filesystem($credentials) ) {
+    $error = true;
+    if ( is_object($wp_filesystem) && $wp_filesystem->errors->get_error_code() )
+      $error = $wp_filesystem->errors;
+    $this->skin->request_filesystem_credentials($error); //Failed to connect, Error and request again
+    return false;
+  }
+
+  if ( ! is_object($wp_filesystem) )
+    return new WP_Error('fs_unavailable', $this->strings['fs_unavailable'] );
+
+  if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
+    return new WP_Error('fs_error', $this->strings['fs_error'], $wp_filesystem->errors);
+
+  foreach ( (array)$directories as $dir ) {
+        if ( ! $wp_filesystem->find_folder($dir) )
+          return new WP_Error('fs_no_folder', sprintf($this->strings['fs_no_folder'], $dir));
+  }
+  return true;
+}
+
+function check_filesystem(){
+  $msg = array();
+  if(!class_exists('ZipArchive')){
+    $msg['zip'] = 'Your server is not able to extract zip files (PHP Class "ZipArchive" not found).';
+  }
+
+  // Check file system method
+
+  $method = null;
+  $fs_msg = '';
+  if ( function_exists('getmyuid') && function_exists('fileowner') ){
+    $context = trailingslashit(EDGE_SUITE_PUBLIC_DIR);
+    $temp_file_name = $context . 'temp-write-test-edge-' . time();
+    $temp_handle = @fopen($temp_file_name, 'w');
+    if ( $temp_handle ) {
+      $myuid = getmyuid();
+      $owner = @fileowner($temp_file_name);
+      @fclose($temp_handle);
+      @unlink($temp_file_name);
+      if ( $myuid == $owner )
+        $method = 'direct';
+      else {
+        $fs_msg = 'The owner of the scripts (most likely your FTP user) is different from the user that runs the PHP server process. </br>';
+        $fs_msg .= 'Files handled through Edge Suite might not be manually deletable by you through FTP. <br>';
+        $fs_msg .= 'Alternative uploading methods are on the roadmap for Edge Suite.';
+      }
+    }
+    else{
+      $fs_msg = 'Tmp test file could not be written to ' . EDGE_SUITE_PUBLIC_DIR;
+    }
+  }
+  else{
+    $fs_msg = 'PHP functions getmyuid() and fileowner() could not be found.';
+  }
+  if(!empty($fs_msg)){
+    $msg['filesystem'] = $fs_msg;
+  }
+
+  return $msg;
+
+}
+
+
+function unzip($file, $to){
+  if ( class_exists('ZipArchive') && apply_filters('unzip_file_use_ziparchive', true ) ) {
+
+
+    require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+    require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-direct.php');
+    $filesystem = new WP_Filesystem_Direct(null);
+
+    $z = new ZipArchive();
+
+    // PHP4-compat - php4 classes can't contain constants
+    $zopen = $z->open($file, /* ZIPARCHIVE::CHECKCONS */ 4);
+    if ( true !== $zopen )
+      return new WP_Error('incompatible_archive', __('Incompatible Archive.'));
+
+
+    for ( $i = 0; $i < $z->numFiles; $i++ ) {
+      if ( ! $info = $z->statIndex($i) )
+        return new WP_Error('stat_failed', __('Could not retrieve file from archive.'));
+
+      if ( '/' == substr($info['name'], -1) ) // directory
+        continue;
+
+      if ( '__MACOSX/' === substr($info['name'], 0, 9) ) // Don't extract the OS X-created __MACOSX directory files
+        continue;
+
+      if(!preg_match('/(.*)\.(' . EDGE_SUITE_ALLOWED_ASSET_EXTENSIONS . ')$/', $info['name'])){
+        continue;
+      }
+
+      $dir_creation = mkdir_recursive(trailingslashit($to) . dirname($info['name']));
+      $contents = $z->getFromIndex($i);
+      if ( false === $contents )
+        return new WP_Error('extract_failed', __('Could not extract file from archive.'), $info['name']);
+
+      if ( ! $filesystem->put_contents( trailingslashit($to) . $info['name'], $contents, FS_CHMOD_FILE) )
+        return new WP_Error('copy_failed', __('Could not copy file.'), $to . $info['name']);
+    }
+
+    $z->close();
+
+    return true;
+
+  }
+}
 
 function file_scan_directory($dir, $pattern) {
@@ -13 +132 @@
 }
 
-function rmdir_recursive($path) {
-  global $wp_filesystem;
-  $wp_filesystem->rmdir($path, TRUE);
+function rmdir_recursive($dir) {
+  //global $wp_filesystem;
+  foreach(glob($dir . '/*') as $file) {
+    if(@is_dir($file))
+      rmdir_recursive($file);
+    else
+      @unlink($file);
+  }
+  @rmdir($dir);
 }
 
@@ -28 +153 @@
 
 function dir_is_writable($path){
-  global $wp_filesystem;
-  return $wp_filesystem->is_writable($path);
+  //global $wp_filesystem;
+  return is_writable($path);
+}
+
+
+function move_file($source, $destination){
+  // Todo: add overwrite flag
+  // Todo: copy new file, delete old file
+  return rename($source, $destination);
+
 }
 

edge-suite/trunk/readme.txt

@@ -1 +1 @@
 === Edge Suite ===
 Contributors: ti2m
-Tags: media, animation, interactive, adobe edge, edge animate, edge, embed, integration
+Tags: media, animation, interactive, adobe edge animate, edge animate, edge, embed, integration
 Requires at least: 4.3
 Tested up to: 4.3
@@ -17 +17 @@
 Since Edge Animate itself is still in pre-release this plugin is a moving target as well and should therefore not yet be used in production.
 
+There have been problems with unzipping composition archives on shared hosting plans due to the wordpress filesystem. More detailed info is available in the FAQ section.
+
+Roadmap: FTP Filesystem support, data injection
+
 Please help to review and test the plugin. Feedback is appreciated.
 
@@ -25 +29 @@
 * Easy placement of compositions on the website
 
+== Frequently Asked Questions ==
+
+= PHP ZipArchive not found =
+
+zip.so needs to be installed as a PHP library
 
 == Installation ==
@@ -50 +59 @@
 
 Please report any bugs to the Edge Suite support queue on wordpress.
+
+
+== Changelog ==
+
+= 0.2 =
+Change of filesystem usage