MDL-28019 Added plugin repository_areafiles
authorMarina Glancy <marina@moodle.com>
Thu, 18 Jul 2013 04:29:13 +0000 (14:29 +1000)
committerDamyon Wiese <damyon@moodle.com>
Tue, 23 Jul 2013 06:12:45 +0000 (14:12 +0800)
lib/pluginlib.php
repository/areafiles/db/access.php [new file with mode: 0644]
repository/areafiles/db/install.php [new file with mode: 0644]
repository/areafiles/lang/en/repository_areafiles.php [new file with mode: 0644]
repository/areafiles/lib.php [new file with mode: 0644]
repository/areafiles/pix/icon.gif [new file with mode: 0644]
repository/areafiles/version.php [new file with mode: 0644]

index 70c977e..c877372 100644 (file)
@@ -810,7 +810,7 @@ class plugin_manager {
             ),
 
             'repository' => array(
-                'alfresco', 'boxnet', 'coursefiles', 'dropbox', 'equella', 'filesystem',
+                'alfresco', 'areafiles', 'boxnet', 'coursefiles', 'dropbox', 'equella', 'filesystem',
                 'flickr', 'flickr_public', 'googledocs', 'local', 'merlot',
                 'picasa', 'recent', 'skydrive', 's3', 'upload', 'url', 'user', 'webdav',
                 'wikimedia', 'youtube'
diff --git a/repository/areafiles/db/access.php b/repository/areafiles/db/access.php
new file mode 100644 (file)
index 0000000..24f7bf4
--- /dev/null
@@ -0,0 +1,36 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Plugin capabilities for repository_areafiles
+ *
+ * @package    repository_areafiles
+ * @copyright  2013 Marina Glancy
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$capabilities = array(
+
+    'repository/areafiles:view' => array(
+        'captype' => 'read',
+        'contextlevel' => CONTEXT_MODULE,
+        'archetypes' => array(
+            'user' => CAP_ALLOW
+        )
+    )
+);
diff --git a/repository/areafiles/db/install.php b/repository/areafiles/db/install.php
new file mode 100644 (file)
index 0000000..bfb6e4e
--- /dev/null
@@ -0,0 +1,34 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Creating a default instance of areafiles repository on install
+ *
+ * @package    repository_areafiles
+ * @copyright  2013 Marina Glancy
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+function xmldb_repository_areafiles_install() {
+    global $CFG;
+    $result = true;
+    require_once($CFG->dirroot.'/repository/lib.php');
+    $areafiles_plugin = new repository_type('areafiles', array(), true);
+    if(!$id = $areafiles_plugin->create(true)) {
+        $result = false;
+    }
+    return $result;
+}
diff --git a/repository/areafiles/lang/en/repository_areafiles.php b/repository/areafiles/lang/en/repository_areafiles.php
new file mode 100644 (file)
index 0000000..2e946e0
--- /dev/null
@@ -0,0 +1,28 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Strings for component 'repository_areafiles'
+ *
+ * @package   repository_areafiles
+ * @copyright 2013 Marina Glancy
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['areafiles:view'] = 'View repository Embedded files';
+$string['configplugin'] = 'Configuration for repository Embedded files';
+$string['pluginname_help'] = 'Files embedded in the current text editor';
+$string['pluginname'] = 'Embedded files';
diff --git a/repository/areafiles/lib.php b/repository/areafiles/lib.php
new file mode 100644 (file)
index 0000000..bce6e38
--- /dev/null
@@ -0,0 +1,135 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Class repository_areafiles
+ *
+ * @package   repository_areafiles
+ * @copyright 2013 Marina Glancy
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/repository/lib.php');
+
+/**
+ * Main class responsible for files listing in repostiory_areafiles
+ *
+ * @package   repository_areafiles
+ * @copyright 2013 Marina Glancy
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class repository_areafiles extends repository {
+    /**
+     * Areafiles plugin doesn't require login, so list all files
+     *
+     * @return mixed
+     */
+    public function print_login() {
+        return $this->get_listing();
+    }
+
+    /**
+     * Get file listing
+     *
+     * @param string $path
+     * @param string $path not used by this plugin
+     * @return mixed
+     */
+    public function get_listing($path = '', $page = '') {
+        global $USER, $OUTPUT;
+        $itemid = optional_param('itemid', 0, PARAM_INT);
+        $env = optional_param('env', 'filepicker', PARAM_ALPHA);
+        $ret = array(
+            'dynload' => true,
+            'nosearch' => true,
+            'nologin' => true,
+            'list' => array(),
+        );
+        if (empty($itemid) || $env !== 'editor') {
+            return $ret;
+        }
+
+        // In the most cases files embedded in textarea do not have subfolders. Do not show path by default.
+        $retpath = array(array('name' => get_string('files'), 'path' => ''));
+        if (!empty($path)) {
+            $pathchunks = preg_split('|/|', trim($path, '/'));
+            foreach ($pathchunks as $i => $chunk) {
+                $retpath[] = array(
+                    'name' => $chunk,
+                    'path' => '/'. join('/', array_slice($pathchunks, 0, $i + 1)). '/'
+                );
+            }
+            $ret['path'] = $retpath; // Show path if already inside subfolder.
+        }
+
+        $context = context_user::instance($USER->id);
+        $fs = get_file_storage();
+        $files = $fs->get_directory_files($context->id, 'user', 'draft', $itemid,
+                empty($path) ? '/' : $path, false, true);
+        foreach ($files as $file) {
+            if ($file->is_directory()) {
+                $node = array(
+                    'title' => basename($file->get_filepath()),
+                    'path' => $file->get_filepath(),
+                    'children' => array(),
+                    'datemodified' => $file->get_timemodified(),
+                    'datecreated' => $file->get_timecreated(),
+                    'icon' => $OUTPUT->pix_url(file_folder_icon(24))->out(false),
+                    'thumbnail' => $OUTPUT->pix_url(file_folder_icon(90))->out(false)
+                );
+                $ret['list'][] = $node;
+                $ret['path'] = $retpath; // Show path if subfolders exist.
+                continue;
+            }
+            $fileurl = moodle_url::make_draftfile_url($itemid, $file->get_filepath(), $file->get_filename());
+            $node = array(
+                'title' => $file->get_filename(),
+                'size' => $file->get_filesize(),
+                'source' => $fileurl->out(),
+                'datemodified' => $file->get_timemodified(),
+                'datecreated' => $file->get_timecreated(),
+                'author' => $file->get_author(),
+                'license' => $file->get_license(),
+                'isref' => $file->is_external_file(),
+                'icon' => $OUTPUT->pix_url(file_file_icon($file, 24))->out(false),
+                'thumbnail' => $OUTPUT->pix_url(file_file_icon($file, 90))->out(false)
+            );
+            if ($file->get_status() == 666) {
+                $node['originalmissing'] = true;
+            }
+            if ($imageinfo = $file->get_imageinfo()) {
+                $node['realthumbnail'] = $fileurl->out(false, array('preview' => 'thumb', 'oid' => $file->get_timemodified()));
+                $node['realicon'] = $fileurl->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
+                $node['image_width'] = $imageinfo['width'];
+                $node['image_height'] = $imageinfo['height'];
+            }
+            $ret['list'][] = $node;
+        }
+        $ret['list'] = array_filter($ret['list'], array($this, 'filter'));
+        return $ret;
+    }
+
+    /**
+     * This plugin only can return link
+     *
+     * @return int
+     */
+    public function supported_returntypes() {
+        return FILE_EXTERNAL;
+    }
+}
\ No newline at end of file
diff --git a/repository/areafiles/pix/icon.gif b/repository/areafiles/pix/icon.gif
new file mode 100644 (file)
index 0000000..4726498
Binary files /dev/null and b/repository/areafiles/pix/icon.gif differ
diff --git a/repository/areafiles/version.php b/repository/areafiles/version.php
new file mode 100644 (file)
index 0000000..fb7ec4d
--- /dev/null
@@ -0,0 +1,29 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Version information for plugin repository_areafiles
+ *
+ * @package   repository_areafiles
+ * @copyright 2013 Marina Glancy
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2013061200;        // The current plugin version (Date: YYYYMMDDXX)
+$plugin->requires  = 2012062500;        // Requires this Moodle version (Moodle 2.3 - 2.5)
+$plugin->component = 'repository_areafiles'; // Full name of the plugin (used for diagnostics)