MediaWiki extensions manual

PageAttachment Release status: unmaintained
Implementation	User interface, User activity , Skin , Ajax, Special page , Database
Description	This extension extends MediaWiki to allow adding files to a page as attachments.
Author(s)	Aldrin Baroi (Aldrintalk)
Latest version	See Compatibility Section
MediaWiki	See Compatibility Section
PHP	5.4, 5.3, 5.2
Database changes	Yes
License	GNU General Public License 3.0
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net . README
Hooks used LoadExtensionSchemaUpdates BeforeInitialize EditPage::importFormData ArticleSaveComplete BeforePageDisplay SkinAfterContent SkinAfterBottomScripts UploadForm:initial UploadForm:BeforeProcessing UploadComplete SpecialUploadComplete UserLoginComplete UserLogoutComplete ArticleDelete FileDeleteComplete FileUndeleteComplete LinksUpdate LinksUpdateComplete MagicWordwgVariableIDs LanguageGetMagic ParserBeforeInternalParse

The PageAttachment extension allows adding files to a page as attachments.

By default, attachments are only allowed to be added to pages in the "Main" namespace. Through configuration changes, attachments can be allowed to be attached to any other pages under other namespaces, for example, "User Talk" pages.

Security

Every precaution has been taken to make this extension secure by following guidelines outlined in MediaWiki's security manual for developers.

See Security for developers

If you identify any security (or any other) issues, please, open a bug report at the following link:

PageAttachment Issues

What is new?

New Versions Released: (January 21, 2013)

• 3.1.0
• 3.1.0 PHP 5.2.3
• 2.3.0
• 2.3.0 PHP 5.2
• 1.5.0
• 1.5.0 PHP 5.2

See compatibility section to choose the right version for you platform

The foregoing releases contain the following fixes/enhancements:

Version 3.1.0 Only

• Issue# 67 - Browse/Search & Attach Files function returns error message...
  • Part 1) Fixed - IContextSource issue
    • Impacted PHP 5.2.3 only (MediaWiki 1.19 & 1.20)
  • Part 2) Fixed - Attachment option disappears on browsing beyond first page or, executing search function
    • Impacted PHP 5.3 & 5.4 (MediaWiki 1.20 Only)
  • Part 3) Fixed - Search not working

Version 3.1.0, 2.3.0, 1.5.0

• Issue# 65 - PageAttachment not setting filelinks (backlinks)
  • Maintenance script to update file links for existing attachments is included
    • You can run the script using the following command from MediaWiki install directory:
      
      php extensions/PageAttachment/maintenance/AddMissingFileLinks.php
      

New Versions Released: (January 13, 2013)

• 3.0.1 PHP 5.2.3

This release contains the following fixes/enhancements:

• Issue 67: Browse/Search & Attach Files function returns error message...
  • Was partially fixed

New Versions Released: (December 28, 2012)

• 3.0.0
• 3.0.0 PHP 5.2.3
• 2.2.0
• 2.2.0 PHP 5.2

See compatibility section to choose the right version for you platform.

This release contains the following fixes/enhancements:

Version 3.0.0 Only

• Issue 39: Fatal error: Call to private method LinksUpdate::getExistingCategories() from context 'PageAttachment\Category\CategoryManager'
• Issue 40: Page Attachments List Section Does Not Load
• Issue 41: Catchable fatal error: Argument 1 passed to ImageListPager::__construct() must implement interface IContextSource...
• Issue 47: Get "No such action" error page

Versions 2.2.0 and 3.0.0

• Issue 50: Ability to remove the attachment box on pages? __NoAttachment__ for example?
• Issue 52: Specify default pages to have attachments using category names
• Issue 53: Specify exclusion pages through configuration settings
• Issue 54: Allow attachments to a page through the use of "__ATTACHMENT__" token
• Issue 55: Exclude attachments to a page through the use of "__NOATTACHMENT__" token
• Issue 57: Removing attached files (utf8 pages)

Compatibility

TBR: To be released.

* Code checked in.

• Notes on PHP 5.4 release
  • Tested on Ubuntu 12.10 only
• Notes on PHP 5.2.x release
  • PHP 5.2.x compatible release is created by transforming the PHP 5.3 compatible code through the use of "Ant" script.
  • Custom Date Formatting is not supported
  • MediaWiki 1.19 & 1.20 requires PHP 5.2.3 (minimum)

Supported databases

• MySQL
  • Supported in all versions of PageAttachment
• PostgreSQL
  • Supported from PageAttachment version 3.2.0
  • Not yet released
  • Code checked in the default & v3.2.0 branches

Known issues

1. File link (backlinks)
   If you run the "maintenance/refreshLinks.php" script, be sure re-run the "AddMissingFileLinks.php" script; since, "refreshLinks.php" removes the backlinks and need to be recreated.

Usage

Supported use-cases:

• View attachments
• Upload & attach a file
• Browse/search for existing (uploaded) files and attach
• Download an attachment
• Remove an attachment (does not delete the file from MediaWiki repository)
  • Remove an attachment permanentely
    • NOTE: MediaWiki archives the deleted files. You would have to run the maintenance script
          php deleteArchivedFiles.php --delete
      to remove the files from the archive. See: Manual:DeleteArchivedFiles
• View an attachment file's history
• View audit log
  • For a specific attachment
  • For all attachmnets for a page
• Auto remove an attachment when the attachment file is deleted from MediaWiki repository
• Auto restore an attachment when a file deleted from MediaWiki repository is restored and if it was attached to any page
• Set attachment category during upload
• Watch Attachments
• NEW in 3.0.0 and 2.2.0 versions
  • Specify default pages to have attachments using category names
  • Specify exclusion pages through configuration settings
  • Allow attachments to a page through the use of "__ATTACHMENTS__" token
  • Exclude attachments to a page through the use of "__NOATTACHMENTS__" token
• NEW in 3.1.0, 2.3.0, and 1.5.0 versions
  • Auto set file links (back links)
    • Maintenance script to update file links for existing attachments is included
      • You can run the script using the following command from MediaWiki install directory:
        
        php extensoins/PageAttachment/maintenance/AddMissingFileLinks.php
        
        

Note: By default following are turned off/not activated

• Audit logging
• Set attachment category during upload
• Permanent file deletion
• Watch Attachments
• Default pages to have attachments using category names
• Exclusion pages through configuration settings
• Allow attachments to a page through the use of "__ATTACHMENTS__" token
• Exclude attachments to a page through the use of "__NOATTACHMENTS__" token

Download instructions

This project is hosted on GitHub at the following link:

https://github.com/aldrinbaroi/mediawiki-page-attachment

You can also download the code directly via Git from the MediaWiki source code repository

git clone https://github.com/aldrinbaroi/mediawiki-page-attachment.git

Prerequisites

MediaWiki file upload functionality must be enabled for this extension to work. If file upload is not enabled, only "view" activity is allowed.

Please consult: Configuring File Uploads

Installation

• To build the extension, first Apache Ant must be installed
• To build the source code the do the following:

  $ git clone https://github.com/aldrinbaroi/mediawiki-page-attachment
  $ cd mediawiki-page-attachment
  $ ant distribute
  

• Ant has now generated a ZIP archive in the folder dist/. Unpack this archive in your extensions/ folder. Now you should have a PageAttachment/ folder in the extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php:

  require_once("$IP/extensions/PageAttachment/SetupExtension.php");
  

• Update the database
•  Done Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration

It is recommended to use the site specific configuration file to override the defaults and specify site specific settings.

Default configuration file is:

config/DefaultConfigurations.php

Site specific configuration file is:

config/SiteSpecificConfigurations.php

$wgPageAttachment_allowedNameSpaces[] = NS_MAIN;

$wgPageAttachment_allowedNameSpaces[] = NS_TALK; 
$wgPageAttachment_allowedNameSpaces[] = NS_USER; 
$wgPageAttachment_allowedNameSpaces[] = NS_USER_TALK;

$wgPageAttachment_enableAuditLog = true;

    $wgPageAttachment_useInternalCache = true;
    $wgPageAttachment_internalCacheType = 'SQLite3';
    $wgPageAttachment_sqlite3CacheDirectory = 'Absolute path to a directory where web server has read-write access';

    $wgPageAttachment_useInternalCache = true;
    $wgPageAttachment_internalCacheType = 'Database';

    $wgPageAttachment_ajaxCacheDuration = N;

$wgPageAttachment_showUserRealName = false;

$wgPageAttachment_statusMessageFormat['default'] = ' » STATUS_MESSAGE « ';

$wgPageAttachment_statusMessageFormat['default'] = 'YOUR_HTML_CODE STATUS_MESSAGE YOUR_HTML_CODE';

$wgPageAttachment_statusMessageFormat['skin name'] = 'YOUR_HTML_CODE STATUS_MESSAGE YOUR_HTML_CODE';

$wgPageAttachment_dateFormat['en'] = 'M d, Y h:i a';

$wgPageAttachment_dateFormat['en'] = null;

$wgPageAttachment_imgSpacer['default']             = 'transparent-16x16.png';
$wgPageAttachment_imgBrowseSearchAttach['default'] = 'tango-folder-saved-search-16x16.png';
$wgPageAttachment_imgUploadAndAttach['default']    = 'tango-mail-attachment-16x16.png';
$wgPageAttachment_imgAttachFile['default']         = 'tango-mail-attachment-16x16.png';
$wgPageAttachment_imgRemoveAttachment['default']   = 'tango-edit-cut-16x16.png';
$wgPageAttachment_imgViewAuditLog['default']       = 'tango-edit-find-16x16.png';
$wgPageAttachment_imgViewHistory['default']        = 'tango-system-file-manager-16x16.png';

$wgPageAttachment_enableNotification = true;

$wgPageAttachment_useJobQueueForNotification = true;

$wgPageAttachment_messageFormat = 'plaintext';

$wgPageAttachment_messageFormat = 'html';

View/Submit Issues, Enhancement Requests

Please, submit new issue/enhancement-request at the following link:

PageAttachment Issues

Google Discussion Group

Google Discussion Group for PageAttachment Extension