Overview
  • Namespace
  • Class

Namespaces

  • MatthiasWeb
    • RealMediaLibrary
      • api
      • attachment
      • base
      • comp
        • complexquery
      • folder
      • general
      • metadata
      • order
      • rest
      • usersettings
  • None

Classes

  • MatthiasWeb\RealMediaLibrary\attachment\CountCache
  • MatthiasWeb\RealMediaLibrary\attachment\CustomField
  • MatthiasWeb\RealMediaLibrary\attachment\Filter
  • MatthiasWeb\RealMediaLibrary\attachment\Permissions
  • MatthiasWeb\RealMediaLibrary\attachment\Shortcut
  • MatthiasWeb\RealMediaLibrary\attachment\Structure
  • MatthiasWeb\RealMediaLibrary\attachment\Upload
  • MatthiasWeb\RealMediaLibrary\base\Assets
  • MatthiasWeb\RealMediaLibrary\base\Base
  • MatthiasWeb\RealMediaLibrary\base\Core
  • MatthiasWeb\RealMediaLibrary\comp\complexquery\ComplexQuery
  • MatthiasWeb\RealMediaLibrary\comp\complexquery\ResetNames
  • MatthiasWeb\RealMediaLibrary\comp\ExImport
  • MatthiasWeb\RealMediaLibrary\comp\PageBuilders
  • MatthiasWeb\RealMediaLibrary\comp\PolyLang
  • MatthiasWeb\RealMediaLibrary\comp\WPML
  • MatthiasWeb\RealMediaLibrary\folder\BaseFolder
  • MatthiasWeb\RealMediaLibrary\folder\Collection
  • MatthiasWeb\RealMediaLibrary\folder\Creatable
  • MatthiasWeb\RealMediaLibrary\folder\CRUD
  • MatthiasWeb\RealMediaLibrary\folder\Folder
  • MatthiasWeb\RealMediaLibrary\folder\Gallery
  • MatthiasWeb\RealMediaLibrary\folder\Root
  • MatthiasWeb\RealMediaLibrary\general\Activator
  • MatthiasWeb\RealMediaLibrary\general\Assets
  • MatthiasWeb\RealMediaLibrary\general\Core
  • MatthiasWeb\RealMediaLibrary\general\FolderShortcode
  • MatthiasWeb\RealMediaLibrary\general\Lang
  • MatthiasWeb\RealMediaLibrary\general\Migration
  • MatthiasWeb\RealMediaLibrary\general\Options
  • MatthiasWeb\RealMediaLibrary\general\QueryCount
  • MatthiasWeb\RealMediaLibrary\general\Util
  • MatthiasWeb\RealMediaLibrary\general\View
  • MatthiasWeb\RealMediaLibrary\metadata\CoverImage
  • MatthiasWeb\RealMediaLibrary\metadata\Description
  • MatthiasWeb\RealMediaLibrary\metadata\Meta
  • MatthiasWeb\RealMediaLibrary\order\GalleryOrder
  • MatthiasWeb\RealMediaLibrary\order\Sortable
  • MatthiasWeb\RealMediaLibrary\rest\Attachment
  • MatthiasWeb\RealMediaLibrary\rest\Folder
  • MatthiasWeb\RealMediaLibrary\rest\Reset
  • MatthiasWeb\RealMediaLibrary\rest\Service
  • MatthiasWeb\RealMediaLibrary\usersettings\Demo

Interfaces

  • MatthiasWeb\RealMediaLibrary\api\IFolder
  • MatthiasWeb\RealMediaLibrary\api\IFolderActions
  • MatthiasWeb\RealMediaLibrary\api\IFolderContent
  • MatthiasWeb\RealMediaLibrary\api\IMetadata
  • MatthiasWeb\RealMediaLibrary\api\IStructure
  • MatthiasWeb\RealMediaLibrary\api\IUserSettings

Exceptions

  • MatthiasWeb\RealMediaLibrary\general\FolderAlreadyExistsException

Functions

  • _wp_rml_active
  • _wp_rml_root
  • _wp_rml_sanitize
  • _wp_rml_sanitize_filename
  • add_media_folder_meta
  • add_rml_meta_box
  • add_rml_user_settings_box
  • delete_media_folder_meta
  • delete_media_folder_meta_by_key
  • get_media_folder_meta
  • is_rml_folder
  • rml_skip_php_admin_notice
  • rml_skip_rest_admin_notice
  • rml_skip_wp_admin_notice
  • truncate_media_folder_meta
  • update_media_folder_meta
  • wp_attachment_ensure_source_file
  • wp_attachment_folder
  • wp_attachment_get_shortcuts
  • wp_attachment_has_shortcuts
  • wp_attachment_is_shortcut
  • wp_attachment_order_update
  • wp_rml_create
  • wp_rml_create_all_children_sql
  • wp_rml_create_all_parents_sql
  • wp_rml_create_or_return_existing_id
  • wp_rml_create_shortcuts
  • wp_rml_created_shortcuts_last_ids
  • wp_rml_delete
  • wp_rml_dropdown
  • wp_rml_dropdown_collection
  • wp_rml_dropdown_gallery
  • wp_rml_dropdown_gallery_or_collection
  • wp_rml_get_attachments
  • wp_rml_get_by_absolute_path
  • wp_rml_get_by_id
  • wp_rml_get_object_by_id
  • wp_rml_get_parent_id
  • wp_rml_is_type
  • wp_rml_move
  • wp_rml_objects
  • wp_rml_register_creatable
  • wp_rml_rename
  • wp_rml_root_childs
  • wp_rml_structure
  • wp_rml_structure_reset
  • wp_rml_update_count
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 
<?php
namespace MatthiasWeb\RealMediaLibrary\comp;
use MatthiasWeb\RealMediaLibrary\general;
use MatthiasWeb\RealMediaLibrary\attachment;
use MatthiasWeb\RealMediaLibrary\base;

defined( 'ABSPATH' ) or die( 'No script kiddies please!' );

/**
 * Import and export functionality.
 */
class ExImport extends base\Base {
    
    private static $me = null;
    
    private $idOffset = null;
    
    /**
     * Column names for import and export.
     */
    private $columns = array();
    
    private function __construct() {
        $this->columns = explode(",", "name,ord,type,restrictions,contentCustomOrder,importId");
    }
    
    /**
     * Register options in media settings.
     */
    public function options_register() {
        add_settings_field(
            'rml_button_export',
            '<label for="rml_button_export">'.__('Export / Import folders' , RML_TD ).'</label>' ,
            array($this, 'html_rml_button_export'),
            'media',
            'rml_options_reset'
        );
        
        if (count($this->getHierarchicalTaxos())) {
            add_settings_field(
                'rml_button_import_cats',
                '<label for="rml_button_import_cats">'.__('Import taxonomy categories' , RML_TD ).'</label>' ,
                array($this, 'html_rml_button_import_cats'),
                'media',
                'rml_options_reset'
            );
        }
    }
    
    public function html_rml_button_export() { 
        echo '<button class="rml-rest-button button button-primary" data-url="export" data-method="GET">' . __('Export', RML_TD) . '</button>
        <button class="rml-rest-button button" data-url="import" data-method="POST">' . __('Import', RML_TD) . '</button>
        <p class="description" style="margin-bottom:10px">' . __('The export process will respect all available folders. The import process will not touch your existing structure and please make sure the import data does not have duplicate names with your current hierarchy.', RML_TD) . '</p>
        <div id="rml_export_data" style="float:left;margin-right: 10px;"><div>' . __('Exported data:', RML_TD) . '</div><textarea></textarea></div>
        <div id="rml_import_data" style="float:left;"><div>' . __('Import data:', RML_TD) . '</div><textarea></textarea></div>';
    }
    
    public function html_rml_button_import_cats() {
        foreach ($this->getHierarchicalTaxos() as $tax) {
            echo '<button class="rml-rest-button button" data-url="import/taxonomy" data-method="POST" data-taxonomy="' . esc_attr($tax) . '">' . __('Import', RML_TD) . ' \'' . $tax . '\'</button>
            <p class="description">' . __('Imports categories and post relations.', RML_TD) . '</p>';
        }
    }
    
    /**
     * Import a taxonomy with relationships.
     */
    public function importTaxonomy($tax) {
        global $wpdb;
        
        // Import taxonomies
        $this->import($this->getCategories($tax));
        
        $table_name = $this->getTableName();
        $table_name_posts = $this->getTableName("posts");
        
        // Import posts
        $this->debug("Start importing posts for the taxonomy " . $tax . "...", __METHOD__);
        $sql = $wpdb->prepare("INSERT INTO $table_name_posts (`attachment`, `fid`, `importData`)
        SELECT p.ID AS attachment, rml.id AS fid, GROUP_CONCAT(rml.id SEPARATOR ',') AS importData
        FROM $wpdb->posts AS p
        INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id
        INNER JOIN $wpdb->term_taxonomy AS tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id)
        INNER JOIN $wpdb->terms AS t ON t.term_id = tt.term_id
        INNER JOIN $table_name AS rml ON t.term_id = rml.importId
        WHERE p.post_type = 'attachment' AND tt.taxonomy = %s
        GROUP BY p.ID
        ON DUPLICATE KEY UPDATE importData = VALUES(importData)", $tax);
        $wpdb->query($sql);
        
        // Fix isShortcut parameter
        general\Util::getInstance()->fixIsShortcutInPosts();
        
        // Import shortcuts
        $this->importShortcuts();
        $this->_clear();
        attachment\CountCache::getInstance()->resetCountCache();
    }
    
    /**
     * Search the wp_realmedialibrary_posts table for importData contains ","
     * and then create the shortcuts for the splitted "," folders.
     */
    public function importShortcuts() {
        global $wpdb;
        $this->debug("Start importing shortcuts...", __METHOD__);
        $table_name_posts = $this->getTableName("posts");
        $result = $wpdb->get_results("SELECT * FROM $table_name_posts WHERE importData LIKE \"%,%\"", ARRAY_A);
        
        // Grouping
        $group = array();
        foreach ($result as $result) {
            $folders = explode(",", $result["importData"]);
            
            // Iterate all needed folders
            foreach ($folders as $scFid) {
                if ($scFid != $result["fid"]) {
                    $isShortcut = $result["isShortcut"] > 0 ? $result["isShortcut"] : $result["attachment"];
                    $group[] = array("to" => $scFid, "attachment" => $isShortcut);
                }
            }
        }
        
        // Create shortcuts
        $group = general\Util::getInstance()->group_by($group, "to");
        foreach ($group as $to => $attachments) {
            $attachmentIds = array();
            foreach ($attachments as $attachment) {
                $attachmentIds[] = $attachment["attachment"];
            }
            wp_rml_create_shortcuts($to, $attachmentIds, true);
        }
    }
    
    /**
     * Import a tree with __children array and __metas array recursively.
     * 
     * @param array $tree The tree, for example from $this::getFolders()
     */
    public function import($tree) {
        $this->debug("Start importing a tree...", __METHOD__);
        $this->_import($tree);
        general\Util::getInstance()->resetAllSlugsAndAbsolutePathes();
        $this->debug("Importing done", __METHOD__);
        wp_rml_structure_reset();
    }
    
    /**
     * Get the folder tree of a taxonomy for import process.
     * 
     * @returns array
     */
    public function getCategories($tax) {
        global $wpdb;
        $util = general\Util::getInstance();
        
        $result = $wpdb->get_results($wpdb->prepare("SELECT t.term_id as importId, t.name, tt.parent
            FROM $wpdb->terms AS t 
            INNER JOIN $wpdb->term_taxonomy AS tt ON (t.term_id = tt.term_id) 
            WHERE tt.taxonomy = %s
            ORDER BY t.name ASC", $tax), ARRAY_A);
        $tree = $util->buildTree($result, 0, 'parent', 'importId', '__children');
        return $util->clearTree($tree, array("parent"), "__children");
    }
    
    /**
     * Get the folder tree for import process.
     * 
     * @returns array
     */
    public function getFolders() {
        global $wpdb;
        $util = general\Util::getInstance();
        
        // Folders
        $table_name = $this->getTableName();
        $folders = $wpdb->get_results("SELECT id,parent," . implode(",", $this->columns) . " FROM $table_name", ARRAY_A);
        
        // Metas
        $table_name = $this->getTableName("meta");
        $metas = $util->group_by($wpdb->get_results("SELECT * FROM $table_name", ARRAY_A), "realmedialibrary_id");

        // Group metas
        $grouped = array();
        foreach ($folders as $folder) {
            // Assign metas
            if (isset($metas[$folder["id"]])) {
                $folder["__metas"] = array();
                foreach ($metas[$folder["id"]] as $meta) {
                    unset($meta["meta_id"]);
                    unset($meta["realmedialibrary_id"]);
                    $folder["__metas"][] = $meta;
                }
            }
            $grouped[] = $folder;
        }
        
        // Create tree
        $tree = $util->buildTree($grouped, -1, 'parent', 'id', '__children');
        return $util->clearTree($tree, array("id", "parent"), '__children');
    }
    
    /**
     * Get the hierarchical taxonomies for the media taxonomy.
     * 
     * @returns string
     */
    public function getHierarchicalTaxos() {
        // Fetch the taxonomies which are able to filter
        $taxonomy_objects = get_object_taxonomies( 'attachment', 'objects' );
        $taxos = array();
        foreach ($taxonomy_objects as $key => $value) {
            if ($value->hierarchical == 1) {
                $taxos[] = $key;
            }
        }
        return $taxos;
    }
    
    /**
     * Clear importData and importId in posts and folder table.
     */
    private function _clear() {
        global $wpdb;
        $this->debug("Clear importData and importId in posts and folder table...", __METHOD__);
        $table_name = $this->getTableName();
        $table_name_posts = $this->getTableName("posts");
        $wpdb->query("UPDATE $table_name SET importId = NULL");
        $wpdb->query("UPDATE $table_name_posts SET importData = NULL");
    }
    
    /**
     * Import a tree with __children array and __metas array recursively.
     * 
     * @param array $tree The tree, for example from $this::getFolders()
     * @param int $idOffset The id offset for inserting unique keys
     * @param int $parent THe parent for the import
     */
    private function _import($tree, $idOffset = null, $parent = null) {
        global $wpdb;
        
        // Just to get the ID...
        if ($idOffset === null) {
            $this->idOffset = wp_rml_create("Import " . date("Y-m-d H:m:s"), _wp_rml_root(), RML_TYPE_FOLDER, array(), true);
            wp_rml_delete($this->idOffset, true);
        }
        
        // Set default parent
        if ($parent === null) {
            $parent = _wp_rml_root();
        }
        
        if (is_array($tree) && count($tree) > 0) {
            $values = array();
            
            // Flat
            foreach ($tree as $node) {
                $this->idOffset++;
                //error_log("[" . $this->idOffset . "]{" . $parent . "}: " . $node["name"]);
                
                // Create column values
                $columnValues = array($this->idOffset, $parent, get_current_user_id());
                foreach ($this->columns as $column) {
                    if (array_key_exists($column, $node)) {
                        $columnValues[] = $wpdb->prepare("%s", $node[$column]);
                    }else{
                        $columnValues[] = "DEFAULT";
                    }
                }
                $values[] = implode(",", $columnValues);
            }
            
            // SQL Insert
            $sql = "INSERT INTO " . $this->getTableName() . " (`id`,`parent`,`owner`,`" . implode("`,`", $this->columns) . "`) VALUES (" . implode("),(", $values) . ")";
            if ($wpdb->query($sql) !== false) {
                $lastParent = $wpdb->insert_id; // It is the last inserted id
                
                // Next depth and metas
                $metaValues = array(); // Values for metadata...
                foreach (array_reverse($tree) as $node) {
                    if (isset($node["__children"]) && is_array($node["__children"])) {
                        $this->_import($node["__children"], $this->idOffset, $lastParent);
                    }
                    
                    if (isset($node["__metas"]) && is_array($node["__metas"]) && count($node["__metas"]) > 0) {
                        foreach ($node["__metas"] as $meta) {
                            $metaValues[] = $wpdb->prepare("%d, %s, %s", $lastParent, $meta["meta_key"], $meta["meta_value"]);
                        }
                    }
                    $lastParent--;
                }
                
                // SQL Insert meta data
                if (count($metaValues) > 0) {
                    $wpdb->query("INSERT INTO " . $this->getTableName("meta") . " (`realmedialibrary_id`,`meta_key`,`meta_value`) VALUES (" . implode("),(", $metaValues) . ")");
                }
            }
        }
    }
    
    public static function getInstance() {
        return self::$me === null ? self::$me = new ExImport() : self::$me;
    }
}

?>
API documentation generated by ApiGen