扩展:QuickInstantCommons

This page is a translated version of the page Extension:QuickInstantCommons and the translation is 80% complete.
MediaWiki扩展手冊
OOjs UI icon advanced-invert.svg
QuickInstantCommons
發布狀態: 穩定版本
实现 文件存储库
描述 Provides a performance optimized version of InstantCommons
作者 Brian Wolff (Bawolff讨论)
最新版本 1.5
MediaWiki >= 1.35
PHP >= 7.2.11
Composer mediawiki/quickinstantcommons
许可协议 GNU通用公眾授權條款2.0或更新版本
下載
README
  • $wgUseQuickInstantCommons
  • $wgQuickInstantCommonsPrefetchMaxLimit
  • $wgQuickInstantCommonsPrefetch
翻譯QuickInstantCommons扩展,若在translatewiki.net可用

检查使用和版本矩阵。

問題 尚未完成的工作 · 报告錯誤

The QuickInstantCommons extension is a performance optimized version of $wgUseInstantCommons . 此扩展也可以在本地wiki缺少媒体处理器扩展的情况下展示基本的缩略图。 For example, the first page of a PDF will still thumbnail even without Extension:PDFHandler installed, but advanced features like multipage requires the extension to be installed locally.

性能

Initial testing was done using the page en.wikipedia.org: List of governors general of Canada (revision 1054426240) which has 85 images. Testing was done with caching disabled and an estimated TTFB for the API on an already setup connection of ~250ms.

It took 1038.18 seconds with MediaWiki core's instant commons, 18.50 seconds with this extension with prefetching disabled, and 1.10 seconds with this extension but with prefetching enabled.

安装

  • 下载文件,并将其放置在您extensions/文件夹中的QuickInstantCommons目录内。
  • 将下列代码放置在您的LocalSettings.php 的底部:
    wfLoadExtension( 'QuickInstantCommons' );
    
  •   完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
If using this extension, please disable $wgUseInstantCommons as this extension replaces it.

配置

If you were previously using $wgUseInstantCommons, no configuration is needed beyond wfLoadExtension-ing this extension; Configuration is only required for advanced usage.

$wgUseQuickInstantCommons
Automatically setup $wgForeignFileRepos to use this extension (defaults true). Set to false if you need to customize something.
$wgQuickInstantCommonsPrefetch
Enable prefetching images based on what's in DB (Default true). Most of the time this is a major performance boost, but its possible that occasionally this might cause work to be done that isn't necessary.
$wgQuickInstantCommonsPrefetchMaxLimit
Max number of images to prefetch if prefetching is enabled (Default: 1000). Could hit OOM issues if too high.

高级配置

You can directly configure $wgForeignFileRepos if you want. For example, if you want to use this extension with a wiki that is not commons. Example:

  wfLoadExtension( 'QuickInstantCommons' );
  $wgUseQuickInstantCommons = false;
  $wgForeignFileRepos[] = [ 
       'class' => '\MediaWiki\Extension\QuickInstantCommons\Repo',
       'name' => 'commonswiki', // Must be a distinct name
       'directory' => $wgUploadDirectory, // FileBackend needs some value here.
       'apibase' => 'https://commons.wikimedia.org/w/api.php',
       'hashLevels' => 2, // Important this matches foreign repo if 404 transform enabled.
       'thumbUrl' => 'https://upload.wikimedia.org/wikipedia/commons/thumb', // Set to false to auto-detect
       'fetchDescription' => true, // Optional
       'descriptionCacheExpiry' => 43200, // 12 hours, optional (values are seconds). This cache is not adaptive.
       'transformVia404' => true, // Whether foreign repo supports 404 transform. Much faster if supported
       'abbrvThreshold' => 160, // must match what foreign repo uses if 404 transform enabled. Default is 255. Wikimedia uses 160.
       'apiMetadataExpiry' => 60*60*24, // Max time metadata is cached for. Recently changed items are cached for less
       'disabledMediaHandlers' => [TiffHandler::class] // media handler extensions to not use. For 404 handling its important that the local media handler extensions match the foreign ones.
  ];

apiMetadataExpiry is probably the most important value from a performance perspective (other then $wgQuickInstantCommonsPrefetch). If you feel things are slow, try increasing it. If a new version of a file is uploaded, it might not show up properly until after metadata expires. However you can force an expiry by purging the file description page on the local wiki. If you want to maxamize performance, an appropriate value might be 60*60*24*30 (1 month)

Unlike MediaWiki core's ForeignAPIRepo, $wgResponsiveImages should not impact performance when transformVia404 is enabled, so it is recommended that you keep it turned on.
If the foreign repo also has a foreign repo (For example: en.wikipedia.org), then there won't be a single valid thumbUrl. Instead set it to false for the extension to try and auto-detect

Differences between this and ForeignApiFileRepo

  • Caches curl handle
  • Uses HTTP/2 multiplexing (Major performance boost)
  • ?action=purge of File pages purges image metadata
  • Does not support local thumbnail caching
  • Automatically generate thumbnail URLs locally if foreign repository supports 404 handling (Major performance boost. Especially when responsive images are enabled)
  • Prefetch expected images based on imagelinks table (Major performance boost)
  • Allows limited thumbnailing of files that are missing handler extension (e.g. Still show thumbnail of first page of a PDF even if you don't have Extension:PDFHandler installed).
  • Adaptive TTL support that actually works (If the foreign image was recently edited, cache for shorter time, so that if its vandalism the revert will show up faster).
  • Configurable metadata caching time, with better defaults than core.
  • When using a foreign repo that itself has foreign repos (For example, how en.wikipedia.org includes commons.wikimedia.org), image page descriptions will now work correctly.
  • file redirects for files that are foreign files on the foreign repo work.
  • allows disabling media handlers that are incompatible and use fallback behaviour instead.
  • for images that can't use 404 rendering (missing local media handler extension or if transformVia404 false), predictively prefetches the responsive high-dpi thumbnails
  • reuse http/2 connection for fetching description page text
  • do not show text of 404 if the description page is missing on foreign wiki. Instead just show it as blank.

Other ideas that haven't been implemented: better adaptive cache for image description pages.

已知问题

参见