fix #31412 - now allow multiple images in the image block

[project/gallery.git] / contrib / g2_filter / g2_filter.module

<?php\r
// $Id$\r
\r
/**\r
 * @file\r
 * Allows adding gallery blocks into nodes using a filter --> [G2:item_id]\r
 *\r
 */\r
\r
/******************************* Help sections ************************************/\r
\r
function g2_filter_short_tip_translated() {\r
  return t('You may link to G2 items on this site <a href="%explanation-url">using a special syntax</a>',\r
    array('%explanation-url' => url('filter/tips', NULL, 'filter-g2_filter-0')));\r
}\r
\r
function g2_filter_long_tip_translated() {\r
  $prefix = variable_get("g2_filter_prefix", "G2");\r
\r
$output = "";\r
$output .= '<strong>G2 Filter:</strong><p>You can link to items in your ';\r
$output .= 'embedded Gallery 2 using a special code. ';\r
$output .= 'This code will be replaced by a thumbnail image that is ';\r
$output .= 'linked to the actual item in your Gallery. ';\r
$output .= '<em>Syntax:</em><br />';\r
$output .= '<blockquote><code>';\r
$output .= '['.$prefix.':<em>item_id</em> n=<em>number</em> type=<em>type</em> size=<em>number</em> class=<em>name</em> frame=<em>name</em> album_frame=<em>name</em> item_frame=<em>name</em>]';\r
$output .= '</code></blockquote>';\r
\r
$output .= '<ul><li>item_id (required): This is the item ID from G2. ';\r
$output .= 'If you look at the URL of the item, this is the last number.  '\r
			.'<em>Note that if the item_id is a single photo, n must be 1</em></li> ';\r
\r
$output .= '<li>n (suggested): This is the number of photos you want the block to show. ';\r
$output .= 'It will override whatever is set in the defaults (initially 1). '\r
			.' Note: this will change past instances where you did not set n -- the reason for its suggested use.</li> ';\r
\r
$output .= '<li>type: The default type of gallery block. Any of the following may be used: ';\r
$output .= '<em>randomImage, recentImage, viewedImage, randomAlbum, recentAlbum, viewedAlbum, dailyImage, ' \r
			.'weeklyImage, monthlyImage, dailyAlbum, weeklyAlbum, monthlyAlbum, specificItem . </em> '\r
			.'Note that for n=1, selectedItem is automatically chosen regardless of this parameter.</li> ';\r
\r
$output .= '<li>class: The block that G2 returns is wrapped in a DIV so additional styling can be done. ';\r
$output .= 'The classes for this DIV are located in g2_filter.css.  Included with the module ';\r
$output .= 'are "left", "right", and "nowrap". These position the image block to the left or ';\r
$output .= 'right or on a line all its own with the text not wrapping. You can also add your '; \r
$output .= 'own class(es) to the CSS file and they will automatically be available.</li> ';\r
\r
$output .= '<li>size: The length of the longest side for the thumbnail. ';\r
$output .= 'The other side is determined automatically to keep the same aspect ratio.</li> ';\r
\r
$output .= '<li>frame/album_frame/item_frame: You can use just "frame" to assign a frame ';\r
$output .= 'to the thumbnail regardless of whether it\'s for an album or a single item. ';\r
$output .= 'Using aframe will only affect albums and iframe will only affect single items. ';\r
$output .= 'Frames included with the default Gallery 2 install are: ';\r
$output .= 'bamboo, book, brand , dots, flicking, gold, gold2, polaroid, polaroids, shadow, ';\r
$output .= 'shells, slide, solid, notebook, wood.</li>';\r
\r
return t($output);\r
\r
}\r
\r
function g2_filter_help($section = 'admin/help#image_filter') {\r
  $output = '';\r
  switch ($section) {\r
    case 'admin/help#g2_filter':\r
      $output = t('<p>Used to add image blocks from your embedded Gallery 2 to a node \r
			like a blog entry or a story. To enable this feature and learn the proper syntax, \r
			visit the <a href="%filters">filters configuration screen</a>.</p>', \r
			array('%filters' => url('admin/filters')));\r
      \r
			break;\r
    case 'admin/modules#description':\r
      $output = t("Allow users to reference G2 items from nodes.");\r
      break;\r
    case 'filter#short-tip':\r
      return g2_filter_short_tip_translated();\r
    case 'filter#long-tip':\r
      return g2_filter_long_tip_translated();\r
  }\r
\r
  return $output;\r
}\r
\r
\r
/******************************* Configuration ************************************/\r
\r
function g2_filter_get_settings_form() {\r
  $typeMap = array('randomImage' => t('Random image'),\r
		   'recentImage' => t('Recent image'),\r
		   'viewedImage' => t('Viewed image'),\r
		   'randomAlbum' => t('Random album'),\r
		   'recentAlbum' => t('Recent album'),\r
		   'viewedAlbum' => t('Viewed album'),\r
		   'dailyImage' => t('Daily image'),\r
		   'weeklyImage' => t('Weekly image'),\r
		   'monthlyImage' => t('Monthly image'),\r
		   'dailyAlbum' => t('Daily album'),\r
		   'weeklyAlbum' => t('Weekly album'),\r
		   'monthlyAlbum' => t('Monthly album')); \r
//we don't include specificItem, since it can be selected automatically if n=1\r
		   \r
  $output .= form_textfield(t("Filter prefix"), "g2_filter_prefix",\r
             variable_get("g2_filter_prefix", "G2"), 10, 10,\r
             t("Prefix to use with filter. Example: 'G2' means you use [G2: 999]."));  \r
             \r
  $output .= form_select(t('Image Block Type'), 'g2_filter_default_block_type',\r
			  variable_get('g2_filter_default_block_type', 'viewedImage'), $typeMap,\r
			  t('Pick default type of image block you\'d like to use, default is Recent image. Viewed image is by most clicks.'));         \r
			  \r
  $output .= form_textfield(t("Default Number of Images"), "g2_filter_n_images",\r
             variable_get("g2_filter_n_images", 1), 3, 3,\r
             t("How many images you want the default block to show.  Best to keep at 1 and use the n parameter."));  \r
//////*********in fact, should we remove this option all together?  because the way it is now, if you change this to n>1\r
//then instances where n was not specified and item_id is a specific item, the block breaks and nothing is shown.\r
\r
  $output .= form_checkboxes(\r
      t('Default Image Block Settings'),\r
      'g2_filter_default_show',\r
      variable_get('g2_filter_default_show', 'none'),\r
      array('title' => 'Title (the caption)',\r
	    'date' => 'Date',\r
	    'views' => 'View Count',\r
	    'owner' => 'Item owner',\r
	    'heading' => 'Heading',\r
	    'fullSize' => 'Full Size'),\r
      t('Choose the item metadata you\'d like to display by default.  This will change all instances where show parameter was not specified.'));\r
\r
             \r
  $output .= form_textfield(t("Default thumbnail size"), "g2_filter_default_size",\r
             variable_get("g2_filter_default_size", "150"), 3, 3,\r
             t('If no size is specified when calling the filter, this size will be used.  '\r
             .'Note that the display size will be limited by the size of the item_id in Gallery.'));  \r
\r
  $output .= form_textfield(t("Default class"), "g2_filter_default_div_class",\r
             variable_get("g2_filter_default_div_class", "nowrap"), 20, 20,\r
             t("left, right, or nowrap. (See g2_filter.css to add more or modify these.)"));  \r
\r
  $output .= form_textfield(t("Default album frame"), "g2_filter_default_album_frame",\r
             variable_get("g2_filter_default_album_frame", "none"), 20, 20,\r
             t("Enter a frame name like notebook, polaroid, shadow, slide, wood, etc. See your G2 install for a complete list. Use 'none' or blank for no frame. "));  \r
\r
  $output .= form_textfield(t("Default item frame"), "g2_filter_default_item_frame",\r
             variable_get("g2_filter_default_item_frame", "none"), 20, 20,\r
             t("Enter a frame name like notebook, polaroid, shadow, slide, wood, etc. See your G2 install for a complete list. Use 'none' or blank for no frame. "));  \r
\r
	return $output;\r
}\r
\r
// Hook which handles filtering.\r
function g2_filter_filter($op, $delta = 0, $format = -1, $text = '') {\r
  switch ($op) {\r
    case 'list':\r
      return array(0 => t('G2 filter'));\r
    case 'description':\r
      return t('Allow users to easily reference G2 items from nodes.');\r
    case 'process':\r
      return g2_filter_process($text);\r
		case 'settings':\r
		  $group = g2_filter_get_settings_form();\r
      return form_group(t("Gallery 2 Filter"), $group);\r
    default:\r
      return $text;\r
  }\r
}\r
\r
function g2_filter_filter_tips($delta = 0, $format = -1, $long = false) {\r
  if ($long) {\r
    return g2_filter_long_tip_translated();\r
  }\r
  else {\r
    return g2_filter_short_tip_translated();\r
  }\r
}\r
\r
// ***************** The Filter in Action ***********************\r
\r
define("G2_FILTER_WORD", 1);\r
define("G2_FILTER_INTEGER", 2);\r
define("G2_FILTER_STRING", 3);\r
\r
function g2_filter_attr_value($text, $value_type = G2_FILTER_WORD) {\r
  // Strip off initial and final quotes.\r
  $first = substr($text, 0, 1);\r
  if ($first == "\"" || $first == "\'") {\r
    if (substr($text, -1, 1) == $first) {\r
      $text = substr($text, 1, -1);\r
    }\r
  }\r
  switch ($value_type) {\r
  case G2_FILTER_WORD:\r
    return preg_replace("/\W/", '', $text);\r
  case G2_FILTER_INTEGER:\r
    return preg_replace("/\D/", '', $text);\r
  default:\r
    return check_plain($text);\r
  }\r
}\r
\r
// Execute filter on given text.\r
function g2_filter_process($text) {\r
\r
  // Find all the image codes and loop over them, replacing each with the G2 image block\r
  $prefix = variable_get("g2_filter_prefix", "G2");\r
\r
	$matchetxt = "/\[".trim($prefix).":(\d+)(\s*,)?\s*(.*?)\]/i";\r
  preg_match_all($matchetxt, $text, $matches, PREG_SET_ORDER);\r
\r
  // If we have at least one match, set everything up\r
  if (count($matches) > 0) { \r
    // Set the default and path variables based on module settings\r
    $default_size        = variable_get("g2_filter_default_size", 150);\r
    $default_div_class   = variable_get("g2_filter_default_div_class", "nowrap");\r
    $default_album_frame = variable_get("g2_filter_default_album_frame", "");\r
    $default_item_frame  = variable_get("g2_filter_default_item_frame", "");\r
	$default_block_type  = variable_get('g2_filter_default_block_type', 'recentImage');\r
	$default_n_images 	 = variable_get("g2_filter_n_images", 1);\r
	$default_show 		 = variable_get('g2_filter_default_show', 'none');\r
	\r
		if ($default_album_frame == 'none') {\r
		  $default_album_frame = '';\r
	  }\r
		if ($default_item_frame == 'none') {\r
		  $default_item_frame = '';\r
	  }		\r
\r
		// This will hold the list of frames used for images so we can add the CSS link(s) at the end\r
		$frame_list = array() ;\r
		\r
/* this is all done by _gallery_init(true) function\r
		// Set up the pathing\r
    $relative_G2_Path  = variable_get("gallery_dir", "gallery2");\r
    $embed_uri         = url('gallery');\r
    $embed_php_path    = $relative_G2_Path . 'embed.php';\r
    //the above line needs work, when the user sets the relative G2 path without a trailing / this module breaks\r
  \r
  // The tolerant base_url patch in http://drupal.org/node/32389 seems to work well, but not all of it is needed.\r
  // The http or https part is not required.\r
  // BUT, does this work for all cases (Apache, IIS?)\r
  if ($dir = trim(dirname($_SERVER['SCRIPT_NAME']), '\,/')) {\r
    $embedPath = "/$dir";\r
  } else {\r
    $embedPath = '/';\r
  }\r
\r
    // Link to the embedding code\r
		require_once($embed_php_path);\r
\r
		// Grab the user information from Drupal\r
		global $user;\r
*/\r
		// This sets up the embedding\r
   list ($success, $ret) = _gallery_init(true); \r
   	//_gallery_init() is from gallery.module, any reason not to use it? \r
	//just remember if they change that function this module breaks\r
   if (!$success) {\r
      gallery_error(t('Unable to initialize embedded Gallery'), $ret);\r
      return;\r
    } /*  since i commented this out, and use galler_init, i can probably get rid of some of the init code above\r
		$ret = GalleryEmbed::init(array('embedUri' => $embed_uri,\r
       'embedPath' => $embed_path,\r
       'relativeG2Path' => $relative_G2_Path,\r
       'loginRedirect' => '',\r
       'fullInit' => true,\r
       'activeUserId' => $user->uid)); */\r
  }\r
\r
	foreach ($matches as $match) {\r
\r
    // Pull out the arguments into the $args array\r
    $args = array();\r
    preg_match_all("/(\w+)\=(\"[^\"]*\"|\S*)/", $match[3], $a, PREG_SET_ORDER);\r
\r
    foreach ($a as $arg) {\r
      $args[strtolower($arg[1])] = $arg[2];\r
    }\r
\r
		// Set number of images to show\r
    $n_images = g2_filter_attr_value($args['n'], G2_FILTER_INTEGER);\r
		if ($n_images == 0) {\r
		  // No size specified; use the default\r
			$n_images = $default_n_images;\r
		}\r
\r
		// Set the block type\r
    $block_type = g2_filter_attr_value($args['type'], G2_FILTER_WORD);\r
		if (empty($block_type)) {\r
		  // No size specified; use the default\r
			$block_type = $default_block_type;\r
		}\r
		if ($n_images <= 1) $block_type = 'specificItem'; //so it shows something if n=1 and an album is selected\r
		\r
		// Set the size of the thumbnail\r
    $size = g2_filter_attr_value($args['size'], G2_FILTER_INTEGER);\r
		if ($size == 0) {\r
		  // No size specified; use the default\r
			$size = $default_size;\r
		}\r
\r
		// Set the class of the div\r
    $div_class = g2_filter_attr_value($args['class'], G2_FILTER_WORD);\r
		if (empty($div_class)) {\r
		  // No class specified; use the default\r
			$div_class = $default_div_class;\r
		}\r
\r
		// Set the overriding, album, and item frames\r
    $frame       = g2_filter_attr_value($args['frame'], G2_FILTER_WORD);\r
    $album_frame = g2_filter_attr_value($args['aframe'], G2_FILTER_WORD);\r
    $item_frame  = g2_filter_attr_value($args['iframe'], G2_FILTER_WORD);\r
\r
		if (empty($frame)) {\r
		  // No overriding frame given; check for album_frame and item_frame\r
		  if (empty($album_frame)) {\r
		    // No album frame specified; use the default one\r
			  $album_frame = $default_album_frame;\r
		  }\r
 \r
		  if (empty($item_frame)) {\r
		    // No item frame specified; use the default one\r
			  $item_frame = $default_item_frame;\r
		  }\r
 \r
    } else {\r
		  // Overriding frame given; use it\r
			$album_frame = $frame;\r
			$item_frame  = $frame;\r
		}\r
\r
		// Add the requested frames to the array so we can get the CSS later. Don't worry about\r
		// dupes at this point; they will be filtered out later.\r
		array_push($frame_list,$frame);\r
		array_push($frame_list,$album_frame);\r
		array_push($frame_list,$item_frame);\r
\r
		// This part actually fetches the image block. It uses the same paramaters as the code\r
		// found under "Image Block" in site admin in G2. Copied and slightly modified here for reference.\r
\r
    // blocks  	  Pipe(|) separate list chosen from: randomImage, recentImage, \r
		//            viewedImage, randomAlbum, recentAlbum, viewedAlbum, dailyImage, \r
		//            weeklyImage, monthlyImage, dailyAlbum, weeklyAlbum, monthlyAlbum, \r
		//            specificItem; default is randomImage\r
    // show  	    Pipe(|) separated list chosen from: title, date, views, owner, heading, \r
		//            fullSize; the value can also be: none\r
		//            NOTE: If you want your size to be bigger than the thumbnail size for that image as\r
		//            defined in your G2, you must use 'show' => 'fullSize'\r
    // itemId 	  Limit the item selection to the subtree of the gallery under the \r
		//            album with the given id; or the id of the item to display when used with \r
		//            specificItem block type\r
    // maxSize 	  Scale images to this maximum size\r
    // linkTarget Add a link target (for example, to open links in a new browser window)\r
    // itemFrame  Image frame to use around images\r
    // albumFrame Image frame to use around albums\r
\r
\r
//$blocks = 'specificItem'; //not used \r
$show = $default_show;\r
\r
// Not customized yet:\r
$link_target = '';  \r
\r
	\r
///////keizo\r
        // Allow for multiple image types\r
        $param_blocks_array = array_fill(0,$n_images,$block_type);   \r
        $params['itemId'] = $match[1];\r
        $params['blocks'] = is_array($param_blocks_array) ? implode('|', $param_blocks_array) : ""; \r
        $param_show_array = $show;\r
        $params['show'] = is_array($param_show_array) ? implode('|', $param_show_array) : ""; \r
        $params['maxSize'] = $size;\r
        // Add frames and link target using g2_filter code from MichelleC\r
        $params['albumFrame'] = $album_frame;\r
        $params['itemFrame'] =  $item_frame;\r
        $params['linkTarget'] =  $link_target;\r
\r
        $block = array();\r
        list($ret, $imageBlockHtml) = GalleryEmbed::getImageBlock($params);\r
        if ($ret->isError()) {\r
          gallery_error(t('Unable to get Gallery image block'), $ret);\r
          return;\r
        } else {\r
          //if ($imageBlockHtml) {  this line is redundant isn't it?\r
			// Add a div around the table for styling\r
			if ($div_class != 'none') {\r
			  $imageBlockHtml = '<div class ="giImageBlock ' . $div_class . '">' .\r
			  $imageBlockHtml . '</div>';\r
			}	\r
				// This puts the image block HTML back into the rest of the text\r
			$text = str_replace($match[0], $imageBlockHtml, $text);\r
          //}\r
        }      \r
 //end keizo\r
/*		list ($ret, $imageBlockHtml) = \r
		GalleryEmbed::getImageBlock(array(\r
		'blocks' => $blocks, \r
		'show' => $show , \r
		'itemId' => $match[1], \r
		'maxSize' => $size, \r
		'linkTarget' => $link_target,\r
		'albumFrame' => $album_frame, \r
		'itemFrame' => $item_frame));\r
\r
		// Add a div around the table for styling\r
    $imageBlockHtml = '<div class ="' . $div_class . '">' . $imageBlockHtml . '</div>';\r
\r
		// This puts the image block HTML back into the rest of the text\r
    $text = str_replace($match[0], $imageBlockHtml, $text);\r
*/\r
\r
\r
  } // end of for loop through matches\r
\r
	// If we had at least one match, finish up\r
  if (count($matches) > 0) { \r
\r
	  GalleryEmbed::done();\r
\r
    // Add the CSS link(s)\r
    $css_links = '';\r
\r
	  // In order to use the album/image frames, we need to link to the style sheet(s)\r
	  $frame_list = array_unique($frame_list);\r
    foreach ($frame_list as $frame) {\r
    $css_links .= '<link rel="stylesheet" href="' . $relative_G2_Path . \r
											'/main.php?g2_controller=imageblock.ExternalCSS&amp;g2_frames=' .$frame.'"/> ' ;\r
    }\r
\r
		// Link to the CSS that controls the styling of the wrapping div\r
		$div_css = drupal_get_path('module', 'g2_filter') . "/g2_filter.css";\r
		$css_links .= '<link rel="stylesheet" href="' . $div_css . '"/> ' ;\r
\r
    $text = $css_links .= $text ;\r
\r
  }\r
\r
  return $text;\r
}\r
\r
\r
?>\r