* Link: http://code.shishnet.org/shimmie2/
* License: GPLv2
* Description: Show a list of uploaded images
* Documentation:
* Here is a list of the search methods available out of the box;
* Shimmie extensions may provide other filters:
*
* - by tag, eg
*
* - cat
*
- pie
*
- somethi* -- wildcards are supported
*
* - size (=, <, >, <=, >=) width x height, eg
*
* - size=1024x768 -- a specific wallpaper size
*
- size>=500x500 -- no small images
*
- size<1000x1000 -- no large images
*
* - width (=, <, >, <=, >=) width, eg
*
* - width=1024 -- find images with 1024 width
*
- width>2000 -- find images bigger than 2000 width
*
* - height (=, <, >, <=, >=) height, eg
*
* - height=768 -- find images with 768 height
*
- height>1000 -- find images bigger than 1000 height
*
* - ratio (=, <, >, <=, >=) width : height, eg
*
* - ratio=4:3, ratio=16:9 -- standard wallpaper
*
- ratio=1:1 -- square images
*
- ratio<1:1 -- tall images
*
- ratio>1:1 -- wide images
*
* - filesize (=, <, >, <=, >=) size, eg
*
* - filesize>1024 -- no images under 1KB
*
- filesize<=3MB -- shorthand filesizes are supported too
*
* - id (=, <, >, <=, >=) number, eg
*
* - id<20 -- search only the first few images
*
- id>=500 -- search later images
*
* - user=Username & poster=Username, eg
*
* - user=Shish -- find all of Shish's posts
*
- poster=Shish -- same as above
*
* - user_id=userID & poster_id=userID, eg
*
* - user_id=2 -- find all posts by user id 2
*
- poster_id=2 -- same as above
*
* - hash=md5sum & md5=md5sum, eg
*
* - hash=bf5b59173f16b6937a4021713dbfaa72 -- find the "Taiga want up!" image
*
- md5=bf5b59173f16b6937a4021713dbfaa72 -- same as above
*
* - filetype=type & ext=type, eg
*
* - filetype=png -- find all PNG images
*
- ext=png -- same as above
*
* - filename=blah & name=blah, eg
*
* - filename=kitten -- find all images with "kitten" in the original filename
*
- name=kitten -- same as above
*
* - posted (=, <, >, <=, >=) date, eg
*
* - posted>=2009-12-25 posted<=2010-01-01 -- find images posted between christmas and new year
*
* - tags (=, <, >, <=, >=) count, eg
*
* - tags=1 -- search for images with only 1 tag
*
- tags>=10 -- search for images with 10 or more tags
*
- tags<25 -- search for images with less than 25 tags
*
* - source=(URL, any, none) eg
*
* - source=http://example.com -- find all images with "http://example.com" in the source
*
- source=any -- find all images with a source
*
- source=none -- find all images without a source
*
* - order=(id, width, height, filesize, filename)_(ASC, DESC), eg
*
* - order=width -- find all images sorted from highest > lowest width
*
- order=filesize_asc -- find all images sorted from lowest > highest filesize
*
*
* Search items can be combined to search for images which match both,
* or you can stick "-" in front of an item to search for things that don't
* match it.
*
Metatags can be followed by ":" rather than "=" if you prefer.
*
I.E: "posted:2014-01-01", "id:>=500" etc.
*
Some search methods provided by extensions:
*
* - Numeric Score
*
* - score (=, <, >, <=, >=) number -- seach by score
*
- upvoted_by=Username -- search for a user's likes
*
- downvoted_by=Username -- search for a user's dislikes
*
- upvoted_by_id=UserID -- search for a user's likes by user ID
*
- downvoted_by_id=UserID -- search for a user's dislikes by user ID
*
- order=score_(ASC, DESC) -- find all images sorted from by score
*
* - Image Rating
*
* - rating=se -- find safe and explicit images, ignore questionable and unknown
*
* - Favorites
*
* - favorites (=, <, >, <=, >=) number -- search for images favourited a certain number of times
*
- favourited_by=Username -- search for a user's choices by username
*
- favorited_by_userno=UserID -- search for a user's choice by userID
*
* - Notes
*
* - notes (=, <, >, <=, >=) number -- search by the number of notes an image has
*
- notes_by=Username -- search for images containing notes created by username
*
- notes_by_userno=UserID -- search for images containing notes created by userID
*
* - Artists
*
* - author=ArtistName -- search for images by artist
*
* - Image Comments
*
* - comments (=, <, >, <=, >=) number -- search for images by number of comments
*
- commented_by=Username -- search for images containing user's comments by username
*
- commented_by_userno=UserID -- search for images containing user's comments by userID
*
* - Pools
*
* - pool=(PoolID, any, none) -- search for images in a pool by PoolID.
*
- pool_by_name=PoolName -- search for images in a pool by PoolName. underscores are replaced with spaces
*
* - Post Relationships
*
* - parent=(parentID, any, none) -- search for images by parentID / if they have, do not have a parent
*
- child=(any, none) -- search for images which have, or do not have children
*
*
*/
/*
* SearchTermParseEvent:
* Signal that a search term needs parsing
*/
class SearchTermParseEvent extends Event {
var $term = null;
var $context = null;
var $querylets = array();
public function SearchTermParseEvent($term, $context) {
$this->term = $term;
$this->context = $context;
}
public function is_querylet_set() {
return (count($this->querylets) > 0);
}
public function get_querylets() {
return $this->querylets;
}
public function add_querylet($q) {
$this->querylets[] = $q;
}
}
class SearchTermParseException extends SCoreException {
}
class PostListBuildingEvent extends Event {
var $search_terms = null;
var $parts = array();
public function __construct($search) {
$this->search_terms = $search;
}
public function add_control(/*string*/ $html, /*int*/ $position=50) {
while(isset($this->parts[$position])) $position++;
$this->parts[$position] = $html;
}
}
class Index extends Extension {
var $stpen = 0; // search term parse event number
public function onInitExt(InitExtEvent $event) {
global $config;
$config->set_default_int("index_images", 24);
$config->set_default_bool("index_tips", true);
$config->set_default_string("index_order", "id DESC");
}
public function onPageRequest(PageRequestEvent $event) {
global $config, $database, $page, $user;
if($event->page_matches("post/list")) {
if(isset($_GET['search'])) {
$search = url_escape(Tag::implode(Tag::resolve_aliases(Tag::explode($_GET['search'], false))));
if(empty($search)) {
$page->set_mode("redirect");
$page->set_redirect(make_link("post/list/1"));
}
else {
$page->set_mode("redirect");
$page->set_redirect(make_link('post/list/'.$search.'/1'));
}
return;
}
$search_terms = $event->get_search_terms();
$page_number = $event->get_page_number();
$page_size = $event->get_page_size();
$count_search_terms = count($search_terms);
try {
#log_debug("index", "Search for ".implode(" ", $search_terms), false, array("terms"=>$search_terms));
$total_pages = Image::count_pages($search_terms);
if(SPEED_HAX && $count_search_terms === 0 && ($page_number < 10)) { // extra caching for the first few post/list pages
$images = $database->cache->get("post-list-$page_number");
if(!$images) {
$images = Image::find_images(($page_number-1)*$page_size, $page_size, $search_terms);
$database->cache->set("post-list-$page_number", $images, 600);
}
}
else {
$images = Image::find_images(($page_number-1)*$page_size, $page_size, $search_terms);
}
}
catch(SearchTermParseException $stpe) {
// FIXME: display the error somewhere
$total_pages = 0;
$images = array();
}
$count_images = count($images);
if($count_search_terms === 0 && $count_images === 0 && $page_number === 1) {
$this->theme->display_intro($page);
send_event(new PostListBuildingEvent($search_terms));
}
else if($count_search_terms > 0 && $count_images === 1 && $page_number === 1) {
$page->set_mode("redirect");
$page->set_redirect(make_link('post/view/'.$images[0]->id));
}
else {
$plbe = new PostListBuildingEvent($search_terms);
send_event($plbe);
$this->theme->set_page($page_number, $total_pages, $search_terms);
$this->theme->display_page($page, $images);
if(count($plbe->parts) > 0) {
$this->theme->display_admin_block($plbe->parts);
}
}
}
}
public function onSetupBuilding(SetupBuildingEvent $event) {
$sb = new SetupBlock("Index Options");
$sb->position = 20;
$sb->add_label("Show ");
$sb->add_int_option("index_images");
$sb->add_label(" images on the post list");
$event->panel->add_block($sb);
}
public function onImageAddition(ImageAdditionEvent $event) {
global $database;
if(SPEED_HAX) {
for($i=1; $i<10; $i++) {
$database->cache->delete("post-list-$i");
}
}
}
public function onImageDeletion(ImageDeletionEvent $event) {
global $database;
if(SPEED_HAX) {
for($i=1; $i<10; $i++) {
$database->cache->delete("post-list-$i");
}
}
}
public function onSearchTermParse(SearchTermParseEvent $event) {
$matches = array();
// check for tags first as tag based searches are more common.
if(preg_match("/^tags([:]?<|[:]?>|[:]?<=|[:]?>=|[:|=])(\d+)$/i", $event->term, $matches)) {
$cmp = ltrim($matches[1], ":") ?: "=";
$tags = $matches[2];
$event->add_querylet(new Querylet('images.id IN (SELECT DISTINCT image_id FROM image_tags GROUP BY image_id HAVING count(image_id) '.$cmp.' '.$tags.')'));
}
else if(preg_match("/^ratio([:]?<|[:]?>|[:]?<=|[:]?>=|[:|=])(\d+):(\d+)$/i", $event->term, $matches)) {
$cmp = preg_replace('/^:/', '=', $matches[1]);
$args = array("width{$this->stpen}"=>int_escape($matches[2]), "height{$this->stpen}"=>int_escape($matches[3]));
$event->add_querylet(new Querylet("width / height $cmp :width{$this->stpen} / :height{$this->stpen}", $args));
}
else if(preg_match("/^(filesize|id)([:]?<|[:]?>|[:]?<=|[:]?>=|[:|=])(\d+[kmg]?b?)$/i", $event->term, $matches)) {
$col = $matches[1];
$cmp = ltrim($matches[2], ":") ?: "=";
$val = parse_shorthand_int($matches[3]);
$event->add_querylet(new Querylet("images.$col $cmp :val{$this->stpen}", array("val{$this->stpen}"=>$val)));
}
else if(preg_match("/^(hash|md5)[=|:]([0-9a-fA-F]*)$/i", $event->term, $matches)) {
$hash = strtolower($matches[2]);
$event->add_querylet(new Querylet('images.hash = :hash', array("hash" => $hash)));
}
else if(preg_match("/^(filetype|ext)[=|:]([a-zA-Z0-9]*)$/i", $event->term, $matches)) {
$ext = strtolower($matches[2]);
$event->add_querylet(new Querylet('images.ext = :ext', array("ext" => $ext)));
}
else if(preg_match("/^(filename|name)[=|:]([a-zA-Z0-9]*)$/i", $event->term, $matches)) {
$filename = strtolower($matches[2]);
$event->add_querylet(new Querylet("images.filename LIKE :filename{$this->stpen}", array("filename{$this->stpen}"=>"%$filename%")));
}
else if(preg_match("/^(source)[=|:](.*)$/i", $event->term, $matches)) {
$source = strtolower($matches[2]);
if(preg_match("/^(any|none)$/i", $source)){
$not = ($source == "any" ? "NOT" : "");
$event->add_querylet(new Querylet("images.source IS $not NULL"));
}else{
$event->add_querylet(new Querylet('images.source LIKE :src', array("src"=>"%$source%")));
}
}
else if(preg_match("/^posted([:]?<|[:]?>|[:]?<=|[:]?>=|[:|=])([0-9-]*)$/i", $event->term, $matches)) {
$cmp = ltrim($matches[1], ":") ?: "=";
$val = $matches[2];
$event->add_querylet(new Querylet("images.posted $cmp :posted{$this->stpen}", array("posted{$this->stpen}"=>$val)));
}
else if(preg_match("/^size([:]?<|[:]?>|[:]?<=|[:]?>=|[:|=])(\d+)x(\d+)$/i", $event->term, $matches)) {
$cmp = ltrim($matches[1], ":") ?: "=";
$args = array("width{$this->stpen}"=>int_escape($matches[2]), "height{$this->stpen}"=>int_escape($matches[3]));
$event->add_querylet(new Querylet("width $cmp :width{$this->stpen} AND height $cmp :height{$this->stpen}", $args));
}
else if(preg_match("/^width([:]?<|[:]?>|[:]?<=|[:]?>=|[:|=])(\d+)$/i", $event->term, $matches)) {
$cmp = ltrim($matches[1], ":") ?: "=";
$event->add_querylet(new Querylet("width $cmp :width{$this->stpen}", array("width{$this->stpen}"=>int_escape($matches[2]))));
}
else if(preg_match("/^height([:]?<|[:]?>|[:]?<=|[:]?>=|[:|=])(\d+)$/i", $event->term, $matches)) {
$cmp = ltrim($matches[1], ":") ?: "=";
$event->add_querylet(new Querylet("height $cmp :height{$this->stpen}",array("height{$this->stpen}"=>int_escape($matches[2]))));
}
else if(preg_match("/^order[=|:](id|width|height|filesize|filename)[_]?(desc|asc)?$/i", $event->term, $matches)){
global $order_sql;
$ord = strtolower($matches[1]);
$default_order_for_column = preg_match("/^(id|filename)$/", $matches[1]) ? "ASC" : "DESC";
$sort = isset($matches[2]) ? strtoupper($matches[2]) : $default_order_for_column;
$order_sql = "$ord $sort";
$event->add_querylet(new Querylet("1=1")); //small hack to avoid metatag being treated as normal tag
}
$this->stpen++;
}
}
?>