MediaWiki  master
FullSearchResultWidget.php
Go to the documentation of this file.
1 <?php
2 
4 
6 use Hooks;
12 use Title;
13 
23  protected $specialPage;
25  protected $linkRenderer;
26 
28  $this->specialPage = $specialPage;
29  $this->linkRenderer = $linkRenderer;
30  }
31 
37  public function render( SearchResult $result, $position ) {
38  // If the page doesn't *exist*... our search index is out of date.
39  // The least confusing at this point is to drop the result.
40  // You may get less results, but... on well. :P
41  if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
42  return '';
43  }
44 
45  $link = $this->generateMainLinkHtml( $result, $position );
46  // If page content is not readable, just return ths title.
47  // This is not quite safe, but better than showing excerpts from
48  // non-readable pages. Note that hiding the entry entirely would
49  // screw up paging (really?).
50  $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
51  if ( !$permissionManager->userCan(
52  'read', $this->specialPage->getUser(), $result->getTitle()
53  ) ) {
54  return "<li>{$link}</li>";
55  }
56 
57  $redirect = $this->generateRedirectHtml( $result );
58  $section = $this->generateSectionHtml( $result );
59  $category = $this->generateCategoryHtml( $result );
60  $date = $this->specialPage->getLanguage()->userTimeAndDate(
61  $result->getTimestamp(),
62  $this->specialPage->getUser()
63  );
64  list( $file, $desc, $thumb ) = $this->generateFileHtml( $result );
65  $snippet = $result->getTextSnippet();
66  if ( $snippet ) {
67  $extract = "<div class='searchresult'>$snippet</div>";
68  } else {
69  $extract = '';
70  }
71 
72  if ( $thumb === null ) {
73  // If no thumb, then the description is about size
74  $desc = $this->generateSizeHtml( $result );
75 
76  // Let hooks do their own final construction if desired.
77  // FIXME: Not sure why this is only for results without thumbnails,
78  // but keeping it as-is for now to prevent breaking hook consumers.
79  $html = null;
80  $score = '';
81  $related = '';
82  // TODO: remove this instanceof and always pass [], let implementors do the cast if
83  // they want to be SearchDatabase specific
84  $terms = $result instanceof \SqlSearchResult ? $result->getTermMatches() : [];
85  if ( !Hooks::run( 'ShowSearchHit', [
86  $this->specialPage, $result, $terms,
87  &$link, &$redirect, &$section, &$extract,
88  &$score, &$desc, &$date, &$related, &$html
89  ] ) ) {
90  return $html;
91  }
92  }
93 
94  // All the pieces have been collected. Now generate the final HTML
95  $joined = "{$link} {$redirect} {$category} {$section} {$file}";
96  $meta = $this->buildMeta( $desc, $date );
97 
98  if ( $thumb === null ) {
99  $html =
100  "<div class='mw-search-result-heading'>{$joined}</div>" .
101  "{$extract} {$meta}";
102  } else {
103  $html =
104  "<table class='searchResultImage'>" .
105  "<tr>" .
106  "<td style='width: 120px; text-align: center; vertical-align: top'>" .
107  $thumb .
108  "</td>" .
109  "<td style='vertical-align: top'>" .
110  "{$joined} {$extract} {$meta}" .
111  "</td>" .
112  "</tr>" .
113  "</table>";
114  }
115 
116  return "<li class='mw-search-result'>{$html}</li>";
117  }
118 
129  protected function generateMainLinkHtml( SearchResult $result, $position ) {
130  $snippet = $result->getTitleSnippet();
131  if ( $snippet === '' ) {
132  $snippet = null;
133  } else {
134  $snippet = new HtmlArmor( $snippet );
135  }
136 
137  // clone to prevent hook from changing the title stored inside $result
138  $title = clone $result->getTitle();
139  $query = [];
140 
141  $attributes = [ 'data-serp-pos' => $position ];
142  Hooks::run( 'ShowSearchHitTitle',
143  [ &$title, &$snippet, $result,
144  $result instanceof \SqlSearchResult ? $result->getTermMatches() : [],
145  $this->specialPage, &$query, &$attributes ] );
146 
147  $link = $this->linkRenderer->makeLink(
148  $title,
149  $snippet,
150  $attributes,
151  $query
152  );
153 
154  return $link;
155  }
156 
167  protected function generateAltTitleHtml( $msgKey, Title $title = null, $text ) {
168  $inner = $title === null
169  ? $text
170  : $this->linkRenderer->makeLink( $title, $text ? new HtmlArmor( $text ) : null );
171 
172  return "<span class='searchalttitle'>" .
173  $this->specialPage->msg( $msgKey )->rawParams( $inner )->parse()
174  . "</span>";
175  }
176 
181  protected function generateRedirectHtml( SearchResult $result ) {
182  $title = $result->getRedirectTitle();
183  return $title === null
184  ? ''
185  : $this->generateAltTitleHtml( 'search-redirect', $title, $result->getRedirectSnippet() );
186  }
187 
192  protected function generateSectionHtml( SearchResult $result ) {
193  $title = $result->getSectionTitle();
194  return $title === null
195  ? ''
196  : $this->generateAltTitleHtml( 'search-section', $title, $result->getSectionSnippet() );
197  }
198 
203  protected function generateCategoryHtml( SearchResult $result ) {
204  $snippet = $result->getCategorySnippet();
205  return $snippet
206  ? $this->generateAltTitleHtml( 'search-category', null, $snippet )
207  : '';
208  }
209 
214  protected function generateSizeHtml( SearchResult $result ) {
215  $title = $result->getTitle();
216  if ( $title->getNamespace() === NS_CATEGORY ) {
217  $cat = Category::newFromTitle( $title );
218  return $this->specialPage->msg( 'search-result-category-size' )
219  ->numParams( $cat->getPageCount(), $cat->getSubcatCount(), $cat->getFileCount() )
220  ->escaped();
221  // TODO: This is a bit odd...but requires changing the i18n message to fix
222  } elseif ( $result->getByteSize() !== null || $result->getWordCount() > 0 ) {
223  $lang = $this->specialPage->getLanguage();
224  $bytes = $lang->formatSize( $result->getByteSize() );
225  $words = $result->getWordCount();
226 
227  return $this->specialPage->msg( 'search-result-size', $bytes )
228  ->numParams( $words )
229  ->escaped();
230  }
231 
232  return '';
233  }
234 
241  protected function generateFileHtml( SearchResult $result ) {
242  $title = $result->getTitle();
243  if ( $title->getNamespace() !== NS_FILE ) {
244  return [ '', null, null ];
245  }
246 
247  if ( $result->isFileMatch() ) {
248  $html = "<span class='searchalttitle'>" .
249  $this->specialPage->msg( 'search-file-match' )->escaped() .
250  "</span>";
251  } else {
252  $html = '';
253  }
254 
255  $descHtml = null;
256  $thumbHtml = null;
257 
258  $img = $result->getFile() ?: MediaWikiServices::getInstance()->getRepoGroup()
259  ->findFile( $title );
260  if ( $img ) {
261  $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
262  if ( $thumb ) {
263  $descHtml = $this->specialPage->msg( 'parentheses' )
264  ->rawParams( $img->getShortDesc() )
265  ->escaped();
266  $thumbHtml = $thumb->toHtml( [ 'desc-link' => true ] );
267  }
268  }
269 
270  return [ $html, $descHtml, $thumbHtml ];
271  }
272 
280  protected function buildMeta( $desc, $date ) {
281  if ( $desc && $date ) {
282  $meta = "{$desc} - {$date}";
283  } elseif ( $desc ) {
284  $meta = $desc;
285  } elseif ( $date ) {
286  $meta = $date;
287  } else {
288  return '';
289  }
290 
291  return "<div class='mw-search-result-data'>{$meta}</div>";
292  }
293 }
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1972
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1529
static newFromTitle( $title)
Factory function.
Definition: Category.php:146
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
if(!isset( $args[0])) $lang
__construct(SpecialSearch $specialPage, LinkRenderer $linkRenderer)
getFile()
Get the file for this page, if one exists.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
static getInstance()
Returns the global default instance of the top level service locator.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1970
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3039
Renders a &#39;full&#39; multi-line search result with metadata.
Class that generates HTML links for pages.
generateMainLinkHtml(SearchResult $result, $position)
Generates HTML for the primary call to action.
getTextSnippet( $terms=[])
const NS_CATEGORY
Definition: Defines.php:74
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
isBrokenTitle()
Check if this is result points to an invalid title.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
const NS_FILE
Definition: Defines.php:66
isFileMatch()
Did this match file contents (eg: PDF/DJVU)?
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3039
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Renders a single search result to HTML.
generateAltTitleHtml( $msgKey, Title $title=null, $text)
Generates an alternate title link, such as (redirect from Foo).
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
isMissingRevision()
Check if target page is missing, happens when index is out of date.