Extension:PageAttachment

What can this extension do?
This extension extends MediaWiki to allow 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, 2011)
 * 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

New Versions Released:  (January 13, 2013)
 * 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
 * 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)

Usage
Supported use-cases: Note: By default following are turned off/not activated
 * 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
 * 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 Google Code at the following link:

MediaWiki PageAttachment on Google Code

This project uses Mercurial repository. You can create your clone using following command:

hg clone https://code.google.com/p/mediawiki-page-attachment/

End-user installable package:

Download MdiaWiki PageAttachment Extension

If you need help with using a Mecurial repository, please take a look at the following links:


 * Mercurial on Wikipedia
 * Mercurial Project Site
 * Mercurial Beginner's Guides

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
Please see the detailed installation instructions on the following link:

PageAttachment Installtion

Configuration
For complete & detail configuration options, see the following link:

Complete & Detail Configuration Options


 * NOTE: The configuration options detailed in the following would be removed in the future.
 * Since the configuration options are huge and hard to maintain on a single page.

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

Allowed Namespaces
Attachments are allowed only on pages under configured namespaces.

By default, only "Main" namespace is enabled:

To add other namespaces, for example, "Talk", "User", and "User Talk" add the following in the site specific configuration file:

MediaWiki User Rights
For upload & attachment activity, check is made to ensure the following:
 * User is not blocked
 * Wiki is not in readonly mode

PageAttachment User Rights
This extension maintains page attachment specific rights separately.

Page attachment specific rights are:
 * View attachments
 * Upload & attach a file
 * Browse/Search for existing (uploaded) files and attach
 * Remove attachments
 * Download attachments
 * View history
 * View audit log (if audit logging is enabled)

NOTE: View rights must be enabled for all other rights to work

The rights can be applied:
 * When login is not required
 * Only at the activity level (e.g. upload & attach a file)
 * When login is required, rights can be applied to each activity
 * At a group level
 * At a user specific level

NOTE: The groups/users must be valid MediaWiki groups/users.

Audit Log
Audit logging by default is turned off. To enable audit logging, set the following:

Cache

 * Server side cache
 * PageAttachment extension uses cache to store page attachment list, attachment data, and article names.
 * MediaWiki's Cache
 * By default, MediaWiki cache is used and recommended.
 * Recommeded for Production use.
 * To use MediaWiki's cache, no configuration change is required.
 * Please consult: MediaWiki Cache Setup
 * '''PageAttachment's Internal Cache
 * Alternatively, you can use one of the two internal cache implementations.
 * * SQLite3 Cache
 * * Database Cache
 * Use internal cache implementations for development & testing purposes only.
 * To use SQLite3 internal cache, set the following in the site-specific configuration file:


 * To use Database cache, set the following in the site-specific configuration file:


 * Browser cache
 * Ajax is used to load the page attachment list.
 * By default Ajax data caching in user's web browser is disabled. The reason for this that Ajax caching will sometime cause inconsistent data display based on when an attachment was added/update/removed and after user's login/logout.
 * If you want to enable Ajax caching, set the following in the site-specific configuration file:


 * N = Number of seconds to cache Ajax data in the user's browser.

User Interface
User Name Format By default, real-user name is displayed, if available. To disable this and to display only user id, set the following: Status Message Display Format The default format applies to all skins. You can override the default and/or provide skin specific formats. The default status message format is: The foregoing is rendered as the following:
 * &#187; STATUS_MESSAGE &#171;

The STATUS_MESSAGE is replaced with the actual message. To change the default format, replace the YOUR_HTML_CODE with your actual HTML code. Please, leave the STATUS_MESSAGE token in: To specify skin specific format, add additional settings and replace 'default' with the actual skin name. Example: Date Format Date formatting is based on MediaWiki settings. You can override this and specify language specific settings. By default, for English language, MediaWiki date format is overriden with the following format: The rendered date looks like, e.g.: Jul 24, 2011 11:17 pm To disable this, unset the foregoing setting as follows: Cascading Style Sheet (CSS) Files Icon Image Files The default icons apply to all skins. You can override the default and/or provide skin specific icons. The default icon image files are: To provide skin specific icons, add additional settings and replace the 'default' with the skin name. Note: The included image files are obtained from Tango Desktop Project and resized. Display Column Widths
 * Common
 * For left-to-right (LTR) language
 * For right-to-left (RTL) language

Watch Attachments
On watched pages, to send notification on attachment activity:


 * Enable MediaWiki email
 * See Manual:$wgEnableEmail & Manual:Configuration settings
 * In the site specific configuration file, set the following:

To send the emails using MediaWiki Job Queue
 * Setup MediaWiki's Job Queue processing
 * See Manual:Job queue
 * In the site specific configuration file, set the following:

Notification emails are formatted using a template. Two templates are included: Note: You must specify which template to use.
 * Plain Text
 * HTML

To use plain-text template, set the following:

To use HTML template, set the following:

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