g2modules  |  g2themes  |  Saulmade  |  Demo

The Search mod extensions - search per album [G2][Search] search per album This is an update on the search module (numbered it 1.0.4) that adds the ability to search per album. An admin page has been created for you to be able to specify what icons/buttons should appear with the search block or whether to use a checkbox; all search per album related. The number of results to appear for both the searchscan and searchshowall pages also have been Parameterized. Please note that the search per album option will never show in the root of you gallery. This update also includes the '[G2][Search] Enhancement to search for each word' patch (https://sourceforge.net/tracker/index.php?func=detail&aid=1243397&... / http://gallery.menalto.com/node/37488) screenshots searchblock with naturetheme admin with naturetheme admin Test the search module at http://www.saulmade.nl/gallery2/ Download the extended search module : Patch @ sourceforge.net Installation instructions : Unpack, then copy the 'modules' directory into your 'gallery2' directory overwriting the existing files. It's anyhow adviced to backup the original files (core class and map + search module). See the General module installation instructions for further information: http://codex.gallery2.org/index.php/Gallery2:User_Contributions#Modules Extensions written By Paul Moers, 12-2006 Special thanks to Jaymis Loveday for supporting me! Licence : GNU * General Public License. Links : - Gallery official website: http://gallery.menalto.com/ - Gallery codex: http://codex.gallery2.org - General module installation instructions: http://codex.gallery2.org/index.php/Gallery2:User_Contributions#Modules Below is a list of changes made to the search mod. (I'm not sure that this completely lists the modifications I made to the search module...) Displayed with the great javascript editor for source code called 'EditArea' created by Christophe Dolivet //modules/core/classes/GalleryCoreSearch.class //on line 75 insert: if (gettype($criteria) == "array") { $albumId = $criteria[1]; $criteria = $criteria[0]; } //Replace both of the $query = sprintf('...'); command on line 120 and 133 with the next code: if ($albumId > 0) { // generate parentSequence all albums we search in need to share list ($ret, $parentSequence) = GalleryCoreApi::fetchParentSequence($albumId); if ($ret) { return array($ret, null); } $sequence = implode('/', $parentSequence); if (!empty($sequence)) { $sequence .= '/'; } $sequence .= $albumId . '/%'; // get the name of the album we're searching in list ($ret, $results) = $gallery->search(sprintf('SELECT [GalleryItem::title] FROM [GalleryItem] WHERE [GalleryItem::id] = %s', $albumId)); if ($ret) { return array($ret->wrap(__FILE__, __LINE__), null); } $result = $results->nextResult(); $albumName = $result[0]; $countQuery = sprintf(' SELECT COUNT([GalleryItem::id]) FROM [GalleryItem], [GalleryAccessSubscriberMap], [GalleryItemAttributesMap] WHERE (' . join(' OR ', $whereList) . ') AND [GalleryItem::id] = [GalleryAccessSubscriberMap::itemId] AND [GalleryItem::id] = [GalleryItemAttributesMap::itemId] AND [GalleryItemAttributesMap::parentSequence] LIKE \'%s\' AND [GalleryAccessSubscriberMap::accessListId] IN (%s) ', $sequence, $aclMarkers); $query = sprintf(' SELECT [GalleryItem::id], [GalleryUser::fullName], [GalleryUser::userName], [GalleryEntity::modificationTimestamp], ' . join(', ', $selectList) . ' FROM [GalleryItem], [GalleryAccessSubscriberMap], [GalleryEntity], [GalleryUser], [GalleryItemAttributesMap] WHERE (' . join(' OR ', $whereList) . ') AND [GalleryItem::id] = [GalleryAccessSubscriberMap::itemId] AND [GalleryItem::id] = [GalleryEntity::id] AND [GalleryItem::id] = [GalleryItemAttributesMap::itemId] AND [GalleryItemAttributesMap::parentSequence] LIKE \'%s\' AND [GalleryUser::id] = [GalleryItem::ownerId] AND [GalleryAccessSubscriberMap::accessListId] IN (%s) ORDER BY [GalleryEntity::modificationTimestamp] DESC, [GalleryItem::id] DESC ', $sequence, $aclMarkers); } else { $countQuery = sprintf(' SELECT COUNT([GalleryItem::id]) FROM [GalleryItem], [GalleryAccessSubscriberMap] WHERE (' . join(' OR ', $whereList) . ') AND [GalleryItem::id] = [GalleryAccessSubscriberMap::itemId] AND [GalleryAccessSubscriberMap::accessListId] IN (%s) ', $aclMarkers); $query = sprintf(' SELECT [GalleryItem::id], [GalleryUser::fullName], [GalleryUser::userName], [GalleryEntity::modificationTimestamp], ' . join(', ', $selectList) . ' FROM [GalleryItem], [GalleryAccessSubscriberMap], [GalleryEntity], [GalleryUser] WHERE (' . join(' OR ', $whereList) . ') AND [GalleryItem::id] = [GalleryAccessSubscriberMap::itemId] AND [GalleryItem::id] = [GalleryEntity::id] AND [GalleryUser::id] = [GalleryItem::ownerId] AND [GalleryAccessSubscriberMap::accessListId] IN (%s) ORDER BY [GalleryEntity::modificationTimestamp] DESC, [GalleryItem::id] DESC ', $aclMarkers); } //On line 251 add 'albumName' => $albumName, //modules/core/classes/Maps.xml //Add somewhere in the maps node of the file, e.g. line 203 <map> <map-name>ChildEntity</map-name> <member> <member-name>parentId</member-name> <member-type>INTEGER</member-type> </member> </map> /* Created modules/search/admin.inc modules/search/templates/admin.tpl modules/search/classes/SearchGeneralHelper.class modules/search/CallBacks.inc For details on the content, check the files... :p */ //modules/search/templates/blocks/blocks.inc //change line 4-8 /*in*/ ); //modules/search/module.inc //line 43 /*change*/ $this->setVersion('1.0.3'); /*in*/ $this->setVersion('1.0.4'); //line 45 /*change*/ $this->setCallbacks(''); /*in*/ $this->setCallbacks('getSystemLinks|getSiteAdminViews'); //line 49 add /** * @see GalleryModule::getSiteAdminViews() */ function getSiteAdminViews() { global $gallery; return array(null, array(array('name' => $gallery->i18n('Search'), 'view' => 'search.Admin'))); } //modules/search/templates/blocks/SearchBlock.tpl //line 7 /*change*/ {if !isset($showAdvancedLink)} {assign var="showAdvancedLink" value="true"} {/if} /*into*/ {g->callback type="search.getVariables"} //line 25 /*change*/ value="{g->text text="Search"}" /*into*/ value="{g->text text="Search"}" //on line 30 add {if $theme.item.parentId}<input type="hidden" name="{g->formVar var="form[albumId]"}" value="{if $theme.item.canContainChildren}{$theme.item.id}{else}{$theme.item.parentId}{/if}" />{/if} {if $block.search.showSearchIcon}<input type="image" style="vertical-align: middle;" name="{g->formVar var="form[searchGallery]"}" alt="{g->text text="Search gallery"}" title="{g->text text="Search gallery"}" src="{if empty($theme.params.colorpack)}{g->url href="modules/search/images/search.gif"}{else}{g->url href='modules/colorpack/packs/'}{$theme.params.colorpack}/images/search.gif{/if}">{/if} {if $block.search.showSearchGalleryIcon}<input type="image" style="vertical-align: middle;" name="{g->formVar var="form[searchGallery]"}" alt="{g->text text="Search gallery"}" title="{g->text text="Search gallery"}" src="{if empty($theme.params.colorpack)}{g->url href="modules/search/images/searchGallery.gif"}{else}{g->url href='modules/colorpack/packs/'}{$theme.params.colorpack}/images/searchGallery.gif{/if}">{/if} {if $block.search.showSearchAlbumIcon && $theme.item.parentId}<input type="image" style="vertical-align: middle;" name="{g->formVar var="form[searchAlbum]"}" alt="{g->text text="Search album"}" title="{g->text text="Search album"}" src="{if empty($theme.params.colorpack)}{g->url href="modules/search/images/searchAlbum.gif"}{else}{g->url href='modules/colorpack/packs/'}{$theme.params.colorpack}/images/searchAlbum.gif{/if}">{/if} //on line 35 add {if $block.search.showCheckbox && $theme.item.parentId} <div> <input type="checkbox" style="vertical-align: middle;" name="{g->formVar var="form[searchAlbum]"}" />{if $block.search.checkboxText}{$block.search.checkboxText}{else}{g->text text="Search only in this album"}{/if} </div> {/if} //line 40 /*change*/ {if $showAdvancedLink} /*into*/ {if $block.search.showAdvancedLink} //modules/search/SearchScan.inc //line 80 /*change*/ SearchUtilities::sanitizeSearchCriteria($form['searchCriteria'])); /*into*/ array(SearchUtilities::sanitizeSearchCriteria($form['searchCriteria']), ($form['searchAlbum'] ? $form['albumId'] : 0))); //line 176 /*change*/ SearchUtilities::sanitizeSearchCriteria($form['searchCriteria']), /*into*/ array(SearchUtilities::sanitizeSearchCriteria($form['searchCriteria']), ($form['searchAlbum'] ? $form['albumId'] : 0)), //on line 249 add 'albumId' => $form['albumId'], 'albumName' => $searchResults['GalleryCoreSearch']['albumName'], 'searchAlbum' => $form['searchAlbum'], //line 121, 122 /* TODO: Parameterize this */ $scanSize = 3; //replace with list ($ret, $scanSize) = GalleryCoreApi::getPluginParameter('module', 'search', 'scanSize'); if ($ret) { return array($ret->wrap(__FILE__, __LINE__), null); } if ($scanSize < 1) { $scanSize = 3; } //modules/search/SearchShowAll.inc //line 141, change SearchUtilities::sanitizeSearchCriteria($form['searchCriteria']), //into array(SearchUtilities::sanitizeSearchCriteria($form['searchCriteria']), ($form['searchAlbum'] ? $form['albumId'] : 0)), //on line 204 add 'albumId' => $form['albumId'], 'albumName' => $results['albumName'], 'searchAlbum' => $form['searchAlbum'], //line 71,72 //replace /* TODO: Parameterize this */ $pageSize = 20; //with list ($ret, $pageSize) = GalleryCoreApi::getPluginParameter('module', 'search', 'pageSize'); if ($ret) { return array($ret->wrap(__FILE__, __LINE__), null); } if ($pageSize < 1) { $pageSize = 20; } //modules/search/templates/SearchScan.tpl (or your 'local' dir) //line 16 add <input type="hidden" name="{g->formVar var="form[albumId]"}" value="{$SearchScan.albumId}"/> <input type="hidden" name="{g->formVar var="form[searchAlbum]"}" value="{$SearchScan.searchAlbum}"/> //line 84 add {if isset($SearchScan.albumName)} <div class="giTitle">{g->text text="Searched in album '%s'" arg1=$SearchScan.albumName|markup:strip}</div> {/if} //modules/search/templates/SearchShowAll.tpl (or your 'local' dir) //line 22 add <input type="hidden" name="{g->formVar var="form[albumId]"}" value="{$SearchShowAll.albumId}"/> <input type="hidden" name="{g->formVar var="form[searchAlbum]"}" value="{$SearchShowAll.searchAlbum}"/> //line 87 add {if isset($SearchShowAll.albumName)} <div class="giTitle">{g->text text="Searched in album '%s'" arg1=$SearchShowAll.albumName|markup:strip}</div> {/if} //line 92 change {g->text text="Results %d - %d of %d, Page %d of %d" arg1=$SearchShowAll.results.start arg2=$SearchShowAll.results.end arg3=$SearchShowAll.results.count arg4=$form.page arg5=$SearchShowAll.maxPages} //into {if $SearchShowAll.results.count == 1} {g->text text="One result"} {elseif $SearchShowAll.maxPages == 1} {g->text text="Results %d - %d" arg1=$SearchShowAll.results.start arg2=$SearchShowAll.results.end} {else} {g->text text="Results %d - %d of %d, Page %d of %d" arg1=$SearchShowAll.results.start arg2=$SearchShowAll.results.end arg3=$SearchShowAll.results.count arg4=$form.page arg5=$SearchShowAll.maxPages} {/if} //For the natureTheme : //modules/search/templates/SearchScan.tpl (or your 'local' dir) //on line 32 add <input type="hidden" name="{g->formVar var="form[albumId]"}" value="{$SearchScan.albumId}"/> <input type="hidden" name="{g->formVar var="form[searchAlbum]"}" value="{$SearchScan.searchAlbum}"/> //modules/search/templates/SearchShowAll.tpl (or your 'local' dir) //on line 61 add <input type="hidden" name="{g->formVar var="form[albumId]"}" value="{$SearchShowAll.albumId}"/> <input type="hidden" name="{g->formVar var="form[searchAlbum]"}" value="{$SearchShowAll.searchAlbum}"/> //on line 172 add {if isset($SearchShowAll.albumName)} <div class="giTitle">{g->text text="Searched in album '%s'" arg1=$SearchShowAll.albumName|markup:strip}</div> {/if} //on line 178 change {g->text text="Results %d of %d, Page %d of %d" arg1=$SearchShowAll.results.end arg2=$SearchShowAll.results.count arg3=$form.page arg4=$SearchShowAll.maxPages} //into {if $SearchShowAll.results.count == 1} {g->text text="One result"} {elseif $SearchShowAll.maxPages == 1} {g->text text="Results %d - %d" arg1=$SearchShowAll.results.start arg2=$SearchShowAll.results.end} {else} {g->text text="Results %d - %d of %d, Page %d of %d" arg1=$SearchShowAll.results.start arg2=$SearchShowAll.results.end arg3=$SearchShowAll.results.count arg4=$form.page arg5=$SearchShowAll.maxPages} {/if}

Links :
Download the extended search module : Patch @ sourceforge.net

Common Links :
- Gallery official website: http://gallery.menalto.com/
- Gallery codex: http://codex.gallery2.org
- General module installation instructions: http://codex.gallery2.org/index.php/Gallery2:User_Contributions#Modules

Other work by Saulmade :
- The natureTheme for gallery2 : http://www.saulmade.nl/naturetheme/
- Skins for the FCKeditor : http://www.saulmade.nl/FCKeditor/FCKSkins.php
- Plugins for the FCKeditor : http://www.saulmade.nl/FCKeditor/FCKPlugins.php
- Snippets for the FCKeditor : http://www.saulmade.nl/FCKeditor/FCKSnippets.php
- The seatingScript : http://www.saulmade.nl/seatingScript/indexEN.html
- Or see the Dutch website including the portfolio (sites) of Saulmade : http://www.saulmade.nl/