M_Attach_To_Post

The NextGEN Gallery M Attach To Post class.

Defined (1)

The class is defined in the following location(s).

/products/photocrati_nextgen/modules/attach_to_post/module.attach_to_post.php  
  1. class M_Attach_To_Post extends C_Base_Module 
  2. { 
  3.     var $attach_to_post_tinymce_plugin = 'NextGEN_AttachToPost'; 
  4.     var $_event_publisher = NULL; 
  5.     static $substitute_placeholders = TRUE; 
  6.  
  7.     /** 
  8.      * Defines the module 
  9.      * @param string|bool $context 
  10.      */ 
  11.     function define($context=FALSE) 
  12.     { 
  13.         parent::define( 
  14.             'photocrati-attach_to_post',  
  15.             'Attach To Post',  
  16.             'Provides the "Attach to Post" interface for displaying galleries and albums',  
  17.             '0.14',  
  18.             'https://www.imagely.com/wordpress-gallery-plugin/nextgen-gallery/',  
  19.             'Photocrati Media',  
  20.             'https://www.imagely.com',  
  21.             $context 
  22.  ); 
  23.  
  24.         C_NextGen_Settings::get_instance()->add_option_handler('C_Attach_To_Post_Option_Handler', array( 
  25.             'attach_to_post_url',  
  26.             'gallery_preview_url',  
  27.             'attach_to_post_display_tab_js_url' 
  28.  )); 
  29.         if (is_multisite()) C_NextGen_Global_Settings::get_instance()->add_option_handler('C_Attach_To_Post_Option_Handler', array( 
  30.             'attach_to_post_url',  
  31.             'gallery_preview_url',  
  32.             'attach_to_post_display_tab_js_url' 
  33.  )); 
  34.  
  35.         C_Photocrati_Installer::add_handler($this->module_id, 'C_Attach_To_Post_Installer'); 
  36.     } 
  37.  
  38.     static function is_atp_url() 
  39.     { 
  40.         return (strpos(strtolower($_SERVER['REQUEST_URI']), NGG_ATTACH_TO_POST_SLUG) !== false) ? TRUE : FALSE; 
  41.     } 
  42.  
  43.     /** 
  44.      * Gets the Frame Event Publisher 
  45.      * @return C_Component 
  46.      */ 
  47.     function _get_frame_event_publisher() 
  48.     { 
  49.         if (is_null($this->_event_publisher)) { 
  50.             $this->_event_publisher = $this->get_registry()->get_utility('I_Frame_Event_Publisher', 'attach_to_post'); 
  51.         } 
  52.  
  53.         return $this->_event_publisher; 
  54.     } 
  55.  
  56.  
  57.     /** 
  58.      * Registers requires the utilites that this module provides 
  59.      */ 
  60.     function _register_utilities() 
  61.     { 
  62.         // This utility provides a controller that renders the 
  63.         // Attach to Post interface, used to manage Displayed Galleries 
  64.         $this->get_registry()->add_utility( 
  65.             'I_Attach_To_Post_Controller',  
  66.             'C_Attach_Controller' 
  67.  ); 
  68.     } 
  69.  
  70.     /** 
  71.      * Registers the adapters that this module provides 
  72.      */ 
  73.     function _register_adapters() 
  74.     { 
  75.         // Installs the Attach to Post module 
  76.         $this->get_registry()->add_adapter( 
  77.             'I_Installer', 'A_Attach_To_Post_Installer' 
  78.  ); 
  79.  
  80.         // Provides AJAX actions for the Attach To Post interface 
  81.         $this->get_registry()->add_adapter( 
  82.             'I_Ajax_Controller', 'A_Attach_To_Post_Ajax' 
  83.  ); 
  84.  
  85.         // Applies a post hook to the generate_thumbnail method of the 
  86.         // gallery storage component 
  87.         $this->get_registry()->add_adapter( 
  88.             'I_Gallery_Storage', 'A_Gallery_Storage_Frame_Event' 
  89.  ); 
  90.     } 
  91.  
  92.     function does_request_require_frame_communication() 
  93.     { 
  94.         return (strpos($_SERVER['REQUEST_URI'], 'attach_to_post') !== FALSE OR strpos($_SERVER['HTTP_REFERER'], 'attach_to_post') !== FALSE OR array_key_exists('attach_to_post', $_REQUEST)); 
  95.     } 
  96.  
  97.  
  98.     function _register_hooks() 
  99.     { 
  100.         add_action('ngg_routes', array(&$this, 'define_routes'), 2); 
  101.  
  102.         // We use two hooks here because we need it to execute for both the post-new.php 
  103.         // page and ATP interface 
  104.         add_action('plugins_loaded', array(&$this, 'fix_ie11'), 1); 
  105.         add_action('admin_init', array(&$this, 'fix_ie11'), PHP_INT_MAX-1); 
  106.         add_action('admin_enqueue_scripts', array(&$this, 'fix_ie11'), 1); 
  107.         add_action('admin_enqueue_scripts', array(&$this, 'fix_ie11'), PHP_INT_MAX-1); 
  108.         add_filter('wpseo_pre_analysis_post_content', array(&$this, 'remove_preview_images_from_yoast_opengraph')); 
  109.         add_filter('wpseo_sitemap_urlimages', array(&$this, 'remove_preview_images_from_yoast_sitemap'), NULL, 2); 
  110.  
  111.         // Emit frame communication events 
  112.         if ($this->does_request_require_frame_communication()) { 
  113.             add_action('ngg_created_new_gallery', array(&$this, 'new_gallery_event')); 
  114.             add_action('ngg_after_new_images_added', array(&$this, 'images_added_event')); 
  115.             add_action('ngg_page_event', array(&$this, 'nextgen_page_event')); 
  116.             add_action('ngg_manage_tags', array(&$this, 'manage_tags_event')); 
  117.         } 
  118.  
  119.         // Admin-only hooks 
  120.         if (is_admin()) { 
  121.             add_action( 
  122.                 'admin_enqueue_scripts',  
  123.                 array(&$this, 'enqueue_static_resources'),  
  124.                 1 
  125.  ); 
  126.  
  127.             add_action('admin_init', array(&$this, 'route_insert_gallery_window')); 
  128.  
  129.             // TODO: In 2.0.69, we're going to change the ATP placeholder urls 
  130.             if (FALSE) { 
  131.                 add_filter('the_editor_content', array($this, 'fix_preview_images')); 
  132.             } 
  133.              
  134.             add_action('media_buttons', array($this, 'add_media_button'), 15); 
  135.         } 
  136.  
  137.         // Frontend-only hooks 
  138.         if (!is_admin()) { 
  139.         // Add hook to subsitute displayed gallery placeholders 
  140.             add_filter('the_content', array(&$this, 'substitute_placeholder_imgs'), PHP_INT_MAX, 1); 
  141.         } 
  142.     } 
  143.  
  144.     /** 
  145.      * Removes IGW preview/placeholder images from Yoast OpenGraph analysis 
  146.      * @param $content 
  147.      * @return mixed 
  148.      */ 
  149.     function remove_preview_images_from_yoast_opengraph($content) 
  150.     { 
  151.         $content = $this->fix_preview_images($content); 
  152.         $content = preg_replace('/http(s)?:\/\/(.*?)'.NGG_ATTACH_TO_POST_SLUG.'\/preview\/id--\d+/', "", $content); 
  153.         $content = preg_replace('/http(s)?:\/\/(.*?)'.NGG_ATTACH_TO_POST_SLUG.'\/preview\/id\/\d+/', "", $content); 
  154.         return $content; 
  155.     } 
  156.  
  157.     /** 
  158.      * Removes IGW preview/placeholder images from Yoast's sitemap 
  159.      * @param $images 
  160.      * @param $post_id 
  161.      * @return array 
  162.      */ 
  163.     function remove_preview_images_from_yoast_sitemap($images, $post_id) 
  164.     { 
  165.         $retval = array(); 
  166.  
  167.         foreach ($images as $image) { 
  168.             if (strpos($image['src'], NGG_ATTACH_TO_POST_SLUG) === FALSE) { 
  169.                 $retval[] = $image; 
  170.             } 
  171.             else { 
  172.                 // Lookup images for the displayed gallery 
  173.                 if (preg_match('/(\d+)$/', $image['src'], $match)) { 
  174.                     $displayed_gallery_id = $match[1]; 
  175.                     $mapper = C_Displayed_Gallery_Mapper::get_instance(); 
  176.                     $displayed_gallery = $mapper->find($displayed_gallery_id, TRUE); 
  177.                     if ($displayed_gallery) { 
  178.                         $gallery_storage = C_Gallery_Storage::get_instance(); 
  179.                         $settings = C_NextGen_Settings::get_instance(); 
  180.                         $source_obj = $displayed_gallery->get_source(); 
  181.                         if (in_array('image', $source_obj->returns)) { 
  182.                             foreach ($displayed_gallery->get_entities() as $image) { 
  183.                                 $named_image_size = $settings->imgAutoResize ? 'full' : 'thumb'; 
  184.  
  185.                                 $sitemap_image = array( 
  186.                                     'src' =>    $gallery_storage->get_image_url($image, $named_image_size),  
  187.                                     'alt' =>    $image->alttext,  
  188.                                     'title' =>    $image->description ? $image->description: $image->alttext 
  189.  ); 
  190.                                 $retval[] = $sitemap_image; 
  191.                             } 
  192.                         } 
  193.                     } 
  194.  
  195.                 } 
  196.             } 
  197.         } 
  198.  
  199.         return $retval; 
  200.     } 
  201.  
  202.     /** 
  203.      * In 2.0.66.X and earlier, ATP placeholder images used a different url than 
  204.      * what 2.0.69 uses. Therefore, we need to convert those 
  205.      * @param $content 
  206.      * 
  207.      * @return mixed 
  208.      */ 
  209.     function fix_preview_images($content) 
  210.     { 
  211.         $content = str_replace( 
  212.             site_url('/'.NGG_ATTACH_TO_POST_SLUG.'/preview/id--'),  
  213.             admin_url('/?'.NGG_ATTACH_TO_POST_SLUG.'='.NGG_ATTACH_TO_POST_SLUG.'/preview/id--'),  
  214.             $content 
  215.  ); 
  216.  
  217.         $content = str_replace( 
  218.             site_url('/index.php/'.NGG_ATTACH_TO_POST_SLUG.'/preview/id--'),  
  219.             admin_url('/?'.NGG_ATTACH_TO_POST_SLUG.'='.NGG_ATTACH_TO_POST_SLUG.'/preview/id--'),  
  220.             $content 
  221.  ); 
  222.  
  223.         return $content; 
  224.     } 
  225.      
  226.     function add_media_button() 
  227.     { 
  228.         $router = C_Router::get_instance(); 
  229.  
  230.         echo '<a href="#" data-editor="content" class="button ngg-add-gallery" id="ngg-media-button" class="button" onclick="tinymce.EditorManager.execCommand(\'ngg_attach_to_post\'); return false;"><img src="' . $router->get_static_url('photocrati-attach_to_post#atp_button.png') . '" style="padding:0; margin-top:-3px;"> ' . __('Add Gallery', 'nggallery') . '</a>'; 
  231.     } 
  232.  
  233.     /** 
  234.     * Route the IGW requests using wp-admin 
  235.     * @throws E_Clean_Exit 
  236.     */ 
  237.     function route_insert_gallery_window() 
  238.     { 
  239.         if (isset($_REQUEST[NGG_ATTACH_TO_POST_SLUG])) { 
  240.             $controller = C_Attach_Controller::get_instance(); 
  241.             if ($_REQUEST[NGG_ATTACH_TO_POST_SLUG] == 'js') { 
  242.                 $controller->display_tab_js_action(); 
  243.             } 
  244.             elseif (strpos($_REQUEST[NGG_ATTACH_TO_POST_SLUG], '/preview') !== FALSE) { 
  245.                 $controller->preview_action(); 
  246.             } 
  247.             else { 
  248.                 $controller->index_action(); 
  249.             } 
  250.  
  251.             throw new E_Clean_Exit; 
  252.         } 
  253.     } 
  254.  
  255.     function define_routes($router) 
  256.     { 
  257.         $app = $router->create_app('/'.NGG_ATTACH_TO_POST_SLUG); 
  258.         $app->rewrite('/preview/{id}', '/preview/id--{id}'); 
  259.         $app->rewrite('/display_tab_js/{id}', '/display_tab_js/id--{id}'); 
  260.         $app->route('/preview', 'I_Attach_To_Post_Controller#preview'); 
  261.         $app->route('/display_tab_js', 'I_Attach_To_Post_Controller#display_tab_js'); 
  262.         $app->route('/', 'I_Attach_To_Post_Controller#index'); 
  263.     } 
  264.  
  265.     /** 
  266.      * WordPress sets the X-UA-Compatible header to IE=edge. Unfortunately, this causes problems with Plupload,  
  267.      * so we have the send this header 
  268.      */ 
  269.     function fix_ie11() 
  270.     { 
  271.         if ((array_search('attach_to_post', array_keys($_REQUEST)) !== FALSE OR strpos($_SERVER['REQUEST_URI'], NGG_ATTACH_TO_POST_SLUG) !== FALSE OR strpos($_SERVER['REQUEST_URI'], 'wp-admin/post.php') !== FALSE OR strpos($_SERVER['REQUEST_URI'], 'wp-admin/post-new.php') !== FALSE)) { 
  272.             if (!headers_sent()) { 
  273.                 header('X-UA-Compatible: IE=EmulateIE10'); 
  274.             } 
  275.         } 
  276.     } 
  277.  
  278.     /** 
  279.      * Substitutes the gallery placeholder content with the gallery type frontend 
  280.      * view, returns a list of static resources that need to be loaded 
  281.      * @param string $content 
  282.      */ 
  283.     function substitute_placeholder_imgs($content) 
  284.     { 
  285.         $content = $this->fix_preview_images($content); 
  286.  
  287.         // To match ATP entries we compare the stored url against a generic path; entries MUST have a gallery ID 
  288.         if (preg_match_all("#<img.*http(s)?://(.*)?".NGG_ATTACH_TO_POST_SLUG."(=|/)preview(/|&|&)id(=|--)(\\d+).*?>#mi", $content, $matches, PREG_SET_ORDER)) { 
  289.  
  290.             $mapper = C_Displayed_Gallery_Mapper::get_instance(); 
  291.             foreach ($matches as $match) { 
  292.                 // Find the displayed gallery 
  293.                 $displayed_gallery_id = $match[6]; 
  294.                 $displayed_gallery = $mapper->find($displayed_gallery_id, TRUE); 
  295.  
  296.                 // Get the content for the displayed gallery 
  297.                 $retval = '<p>'._('Invalid Displayed Gallery').'</p>'; 
  298.                 if ($displayed_gallery) { 
  299.                     $retval = ''; 
  300.                     $renderer = C_Displayed_Gallery_Renderer::get_instance(); 
  301.                     if (defined('NGG_SHOW_DISPLAYED_GALLERY_ERRORS') && NGG_SHOW_DISPLAYED_GALLERY_ERRORS && $displayed_gallery->is_invalid()) { 
  302.                         $retval .= var_export($displayed_gallery->get_errors(), TRUE); 
  303.                     } 
  304.                     if (self::$substitute_placeholders) $retval .= $renderer->render($displayed_gallery, TRUE); 
  305.                 } 
  306.  
  307.                 $content = str_replace($match[0], $retval, $content); 
  308.             } 
  309.         } 
  310.  
  311.         return $content; 
  312.     } 
  313.  
  314.  
  315.     /** 
  316.      * Enqueues static resources required by the Attach to Post interface 
  317.      */ 
  318.     function enqueue_static_resources() 
  319.     { 
  320.         $router = C_Router::get_instance(); 
  321.  
  322.         // Enqueue resources needed at post/page level 
  323.         if (preg_match("/\/wp-admin\/(post|post-new)\.php$/", $_SERVER['SCRIPT_NAME'])) { 
  324.             $this->_enqueue_tinymce_resources(); 
  325.             wp_enqueue_style( 
  326.                 'ngg_attach_to_post_dialog',  
  327.                 $router->get_static_url('photocrati-attach_to_post#attach_to_post_dialog.css'),  
  328.                 FALSE,  
  329.                 NGG_SCRIPT_VERSION 
  330.  ); 
  331.         } 
  332.  
  333.         elseif (isset($_REQUEST['attach_to_post']) OR 
  334.           (isset($_REQUEST['page']) && strpos($_REQUEST['page'], 'nggallery') !== FALSE)) { 
  335.             wp_enqueue_script('iframely', $router->get_static_url('photocrati-attach_to_post#iframely.js'), FALSE, NGG_SCRIPT_VERSION); 
  336.             wp_enqueue_style('iframely', $router->get_static_url('photocrati-attach_to_post#iframely.css'), FALSE, NGG_SCRIPT_VERSION); 
  337.         } 
  338.     } 
  339.  
  340.  
  341.     /** 
  342.      * Enqueues resources needed by the TinyMCE editor 
  343.      */ 
  344.     function _enqueue_tinymce_resources() 
  345.     { 
  346.         wp_localize_script( 
  347.             'media-editor',  
  348.             'nextgen_gallery_attach_to_post_url',  
  349.             C_NextGen_Settings::get_instance()->attach_to_post_url 
  350.  ); 
  351.  
  352.         // Registers our tinymce button and plugin for attaching galleries 
  353.         $security = $this->get_registry()->get_utility('I_Security_Manager'); 
  354.         $sec_actor = $security->get_current_actor(); 
  355.         $checks = array( 
  356.             $sec_actor->is_allowed('NextGEN Attach Interface'),  
  357.             $sec_actor->is_allowed('NextGEN Use TinyMCE') 
  358.  ); 
  359.         if (!in_array(FALSE, $checks)) { 
  360.             if (get_user_option('rich_editing') == 'true') { 
  361.                 add_filter('mce_buttons', array(&$this, 'add_attach_to_post_button')); 
  362.                 add_filter('mce_external_plugins', array(&$this, 'add_attach_to_post_tinymce_plugin')); 
  363.                 add_filter('wp_mce_translation', array($this, 'add_attach_to_post_tinymce_i18n')); 
  364.             } 
  365.         } 
  366.     } 
  367.  
  368.  
  369.     /** 
  370.      * Adds a TinyMCE button for the Attach To Post plugin 
  371.      * @param array $buttons 
  372.      * @returns array 
  373.      */ 
  374.     function add_attach_to_post_button($buttons) 
  375.     { 
  376.         array_push( 
  377.             $buttons,  
  378.             'separator',  
  379.             $this->attach_to_post_tinymce_plugin 
  380.  ); 
  381.         return $buttons; 
  382.     } 
  383.  
  384.  
  385.     /** 
  386.      * Adds the Attach To Post TinyMCE plugin 
  387.      * @param array $plugins 
  388.      * @return array 
  389.      * @uses mce_external_plugins filter 
  390.      */ 
  391.     function add_attach_to_post_tinymce_plugin($plugins) 
  392.     { 
  393.         global $wp_version; 
  394.         $router = C_Router::get_instance(); 
  395.  
  396.         wp_enqueue_script('photocrati_ajax'); 
  397.  
  398.         if ($wp_version >= 3.9) 
  399.             $file = $router->get_static_url('photocrati-attach_to_post#ngg_attach_to_post_tinymce_plugin.js'); 
  400.         else 
  401.             $file = $router->get_static_url('photocrati-attach_to_post#ngg_attach_to_post_tinymce_plugin_wp38_compat.js'); 
  402.  
  403.         $plugins[$this->attach_to_post_tinymce_plugin] = $file; 
  404.         return $plugins; 
  405.     } 
  406.  
  407.  
  408.     /** 
  409.      * Adds the Attach To Post TinyMCE i18n strings 
  410.      * @param $mce_translation 
  411.      * @return mixed 
  412.      */ 
  413.     function add_attach_to_post_tinymce_i18n($mce_translation) 
  414.     { 
  415.         $mce_translation['ngg_attach_to_post.title'] = __('Attach NextGEN Gallery to Post', 'nggallery'); 
  416.         return $mce_translation; 
  417.     } 
  418.  
  419.  
  420.     /** 
  421.      * Notify frames that a new gallery has been created 
  422.      * @param int $gallery_id 
  423.      */ 
  424.     function new_gallery_event($gallery_id) 
  425.     { 
  426.         $gallery = C_Gallery_Mapper::get_instance()->find($gallery_id); 
  427.         if ($gallery) { 
  428.             $this->_get_frame_event_publisher()->add_event(array( 
  429.                 'event' =>    'new_gallery',  
  430.                 'gallery_id'=>    intval($gallery_id),  
  431.                 'gallery_title' =>  $gallery->title 
  432.  )); 
  433.         } 
  434.     } 
  435.  
  436.     /** 
  437.      * Notifies a frame that images have been added to a gallery 
  438.      * @param int $gallery_id 
  439.      * @param array $image_ids 
  440.      */ 
  441.     function images_added_event($gallery_id, $image_ids=array()) 
  442.     { 
  443.         $this->_get_frame_event_publisher()->add_event(array( 
  444.             'event' =>    'images_added',  
  445.             'gallery_id' =>    intval($gallery_id) 
  446.  )); 
  447.     } 
  448.  
  449.     /** 
  450.      * Notifies a frame that the tags have changed 
  451.      * 
  452.      * @param array $tags 
  453.      */ 
  454.     function manage_tags_event($tags = array()) 
  455.     { 
  456.         $this->_get_frame_event_publisher()->add_event(array( 
  457.             'event' => 'manage_tags',  
  458.             'tags' => $tags 
  459.  )); 
  460.     } 
  461.  
  462.     /** 
  463.      * Notifies a frame that an action has been performed on a particular 
  464.      * NextGEN page 
  465.      * @param array $event 
  466.      */ 
  467.     function nextgen_page_event($event) 
  468.     { 
  469.         $this->_get_frame_event_publisher()->add_event($event); 
  470.     } 
  471.  
  472.     function get_type_list() 
  473.     { 
  474.         return array( 
  475.             'A_Attach_To_Post_Ajax' => 'adapter.attach_to_post_ajax.php',  
  476.             'C_Attach_To_Post_Installer' => 'class.attach_to_post_installer.php',  
  477.             'A_Gallery_Storage_Frame_Event' => 'adapter.gallery_storage_frame_event.php',  
  478.             'C_Attach_Controller' => 'class.attach_controller.php',  
  479.             'C_Attach_To_Post_Proxy_Controller' => 'class.attach_to_post_proxy_controller.php',  
  480.             'Mixin_Attach_To_Post_Display_Tab' => 'mixin.attach_to_post_display_tab.php' 
  481.  ); 
  482.     } 
  483. }