1.3.1

Omeka 1.3.1 is a bug-fix release. It was released on January 18, 2011. The release addresses the following:

• Trac ticket #996 - Fixes the item_file() helper when displaying files. Previous, this helper, incorrectly retrieved URLs for files.
• Trac ticket #1001 - Fixes inadvertently discarded collection data when migrating collections on upgrade. Upgrading database from 1.2.1 or earlier will now retrieve full names of collectors.
• Trac ticket #1002 - Checks whether timezone is set in PHP 5.3. If not set, will ask the operating system.
• Trac ticket #1003 - Fixes installer to prevent installation from breaking when non-alphanumeric characters are used for username.
• Omeka admin now validates maintenance releases when checking 'tested_up_to' for plugins and themes.

1.3

Omeka 1.3 was released on December 20, 2010.

New Features

• Converts Omeka admin to use jQuery and jQuery UI. Updates admin panel to use external javascript files. Updates jQuery UI styles to override default behavior for buttons.
• Disables Prototype by default, adds admin panel option to switch it back on if needed for other plugins.
• Adds subnavigation ability to the nav, public_nav, and public_nav_main global helper functions.
• Adds sortable tables to the browse pages in the admin.
• Adds a table for user activations.
• Adds filter for theme options.
• Refactors collections to simplify data entry for collector names. Collector names can now be entered one per line into a textarea on the form, and do not need to be users in Omeka.
• Adds ReCaptcha code and settings to Omeka core.
• Adds Omeka.wysiwyg JS function for implementing TinyMCE.
• Allow theme configs to add the TinyMCE editor.
• Allows plugins to find/use theme configuration options.
• New helpers:
  • element_exists - Checks if an given element and element set are present in Omeka.
  • public_nav_items - Navigation for the items/* pages, with filter.
  • queue_js
  • display_js
  • queue_css
  • display_css
  • button_to
  • delete_button - Creates a form with a single delete button, used instead of links to a delete action.
• New hooks:
  • Adds hook to add content to simple browse view.

Fixed Tickets

• Fixes trac#18 Adds sortable tables.
• Fixes trac#443 by adding a filter to the display HTML flag.
• Fixes trac#733, upgrades getID3 to version 2.0.0b6.
• Fixes trac#787 by adding a callback parameter to the loop_records function, as well as updating loop_items, loop_collections, loop_files, and loop_item_types to internally specify their callback functions to loop_records.
• Fixes trac#900 Adds notification that image derivatives are not being created.
• Fixes trac#905, files in Omeka are stored with hashed filenames.
• Fixes trac#912, organizes elements by element set when used in a form select.
• Fixes trac#916, logout should destroy session and its data.
• Fixes trac#929 RSS2 outputs don't return error when files are associated with items.
• Fixes trac#942 by adding a function to convert URL strings to links.
• Fixes trac#944, adds explanatory text in theme config that theme configuration is on a per-theme basis.
• Fixes trac#958, allows superusers to change all user passwords.
• Fixes trac#961 password reset no longer sent to deactivated users.

Miscellaneous Improvements

• Improved test coverage of Omeka core. Refactors tests to make use of PHPUnit's test suites.
• Fixes installer to set the 'enable_header_check_for_file_mime_types' flag based on whether the fileinfo extension is loaded.
• Fixes users/edit action to redirect back to dashboard instead of users/browse when a user edits their own info.
• Fixes mod_rewrite checking in installer by explicitly allowing access to check-mod-rewrite.html, which could be blocked by more restrictive .htaccess configurations.
• Converts database migrations to use timestamps instead of incremented integers.
• Fixes security hole where form POST could modify a user's salt.
• Updates url_to_link function to use preg_replace instead of ereg_replace; Moves url_to_link function to the admin theme's custom.php file.
• Fixes a javascript bug where the first Use HTML checkbox would save a blank value.
• Fixes a bug on users form where user data was not displayed after invalid password change attempt.
• Fixes Omeka_Core to display the generic error page for all uncaught exceptions.
• Fixes bug in item_has_type helper to use the get magic method to retrieve a given item's item type name instead of using the item() view helper.
• Fixes bug in show_item_metadata / ItemMetadataList. Previous code only works correctly when the item being displayed is the “current item” on the view, would cause fatal error if the item has a type.
• Fixes media helpers for display of AVI,WMV,WMA (particularly on Mac).
• Fixes theme file upload validation check. Reverses check over so the validation will be enabled unless the “disabled” option is equal to 1, leaves validation on in case of an invalid or null value for the option. Adds file size and restricted type/ext validation for theme uploads.
• Moves “add” button for advanced search out of each row. Disables remove buttons when there is only one row.
• Select form element for element sets are now organized by set.

1.2.1

Omeka 1.2.1 was released on June 23, 2010.

Core Changes

• Omeka 1.2.1 fixes a security flaw in the Omeka theme configuration. This applies only to the themes configuration feature that was new in 1.2, so Omeka installations using older versions are not affected. No changes are required for plugins and themes.

1.2

Omeka 1.2 was released on April 8, 2010.

Core Changes

• Adds theme configuration capabilities on a per-theme basis. Theme writers can now add configuration options to their themes, which can be changed by Omeka users from admin.
  • Such configurations include switching CSS-style sheets and adding a logo to the theme's header.
• Adds two new configurable themes to the pre-packaged group of themes: Seasons and Rhythm.
  • Rhythm offers three style sheets for different color palettes. Seasons offers four style sheets and option for uploading a logo file.
• Adds security setting to enable/disable checking a file MIME type by looking at the file header.
• Updates the omeka-xml output to use version 3 of the schema.
• Adds a commented-out RewriteBase rule to various .htaccess files in Omeka.

Admin Theme Changes

• Adds button for configuring themes, if they have a configuration form.
• Add styles to resize img and object elements to prevent overflowing in admin; Updates files/show.php and items/show.php to use the fullsize image when available.
• Updates the Item Type edit form, to make adding elements to an Item Type more user friendly.
• Fixes bug where form errors were not displaying correctly.
• Adds cautionary text in confirm boxes for delete item, delete element set, delete item type, delete collection, delete user, and remove element from item type.

API Changes

• Adds get_theme_option helper to retrieve current theme options set in the admin.
• Updates image helpers for images so that they use the 'alt' option first, then the description in the file metadata, then the title in the file metadata, and finally, if these are unavailable, the item title.
• Fixes get_collections() helper to allow returning collections that are both public and featured.
• Deprecates form helpers in favor of Zend Form methods. The following helpers can still be used, but will be removed in a future release:
  • label()
  • textarea()
  • input()
  • select()

Miscellaneous

• Update Zend to version 1.9.7.

1.1

Omeka 1.1 was released on October 15, 2009.

Core changes

• Omeka now shows only completed metadata for items by default. Adds an option in the settings panel to show all item metadata.
• Adds an Omeka XML schema, and implements that schema in new outputs. More info at http://omeka.org/codex/Response_Formats.
• Adds PHP CLI setting to config.ini, for plugins to use instead of adding a setting.
• Validation on the installer form and settings form. Adds helpful descriptions to settings fields.
• Updates the File MIME Type listing in the Media helper

Admin Interface Improvements

• Makes language in admin UI more consistent
• Adds total number of items links for both admin collection browse pages and item type browse pages. [4477]
• Plugins Page
  • Uses metadata in plugin.ini file.
  • Enforces plugin dependencies
  • Adds plugin Upgrade button.
  • Uninstalling - Establishes a new process for uninstalling plugins, including a confirmation page with a modifiable uninstall message.
• Removing a collector takes user back to the collections/edit page instead of redirecting to the collections/show page.
• Adds a 'View on Public Site' link on admin/items/show and admin/collections/show.
• Database upgrade notice and button is now visible on all Admin pages.

API changes

• Theme API:
  • Updates the item() helper to add 'date modified' as a special argument. [4303]
  • New helper functions for Item Files [4470]
    • recent_files()
    • set_files_for_loop()
    • get_files()
    • get_files_for_loop()
    • loop_files()
    • has_files()
  • New helper functions for Item Types [4477]
    • get_item_types_for_loop()
    • set_item_types_for_loop()
    • loop_item_types()
    • set_current_item_type()
    • get_current_item_type()
    • has_item_types_for_loop()
  • New helper functions for linking to items browse pages [4477]
    • link_to_items_in_collection()
    • link_to_items_with_item_type()
  • collection() helper function - now includes parameter for specific Collection [4501]
  • item_image() helper function - uses the given item object for displaying alt text [4501]
  • link_to() helper function - adds a parameter for an array of query parameters [4477]
  • display_random_featured_item() helper function - does not set the current item to prevent conflicts with items set elsewhere (like on items/show) [4501]
  • display_random_featured_collection() helper function - does not set the current collection to prevent conflicts with collections set elsewhere (like on collections/show) [4501]

• Plugin API:
  • Background processes - plugins can now easily encapsulate, instantiate, and run background processes [4466]
    • Adds Process class
    • Adds ProcessAbstract class
    • Adds ProcessDispatcher class
    • Adds ProcessTable class
  • New helper functions:
    • get_specific_plugin_hook_output() - gets the output of a specific hook belonging to a specific plugin. [4322]
  • New plugin hooks:
    • admin_append_to_plugin_uninstall_message() - Lets plugin developers customize the uninstall message. [4322]
    • upgrade()
    • plugin_append_to_admin_site_info() - Lets plugin developers add HTML to to the site_info panel in the admin header.
    • after_save_record()
    • before_save_record()
    • before_save_form_record()
    • after_save_form_record()
    • before_delete_record()
    • after_delete_record()
    • before_insert_record()
    • after_insert_record()
    • before_update_record()
    • after_update_record()
    • before_validate_record()
    • after_validate_record()

Security Fixes

• Fixes XSS vulnerability in several helper functions. (#838)
• Uses html_escape on URLs when necessary.

Miscellaneous

• Updates Zend to version 1.9.2.

• Fixes a bug in the installer that only allows alpha-numeric characters in the password during validation. [4408]

• Fixes a bug in Collection::totalItems() that returned the wrong count when there were collections of the same name. [4298]

• trac#688 Properly extract IPTC metadata during file uploads. [4396]

• trac#716 fixes errors when using snippet on strings shorter than the number of characters specified [4240]

• trac#801, which prevents users from adding a tag with name '0'. Also fixes the search item filtering so that it finds the a tag called '0'.

• trac#779, Sets the session name to a hash of BASE_DIR, which is unique and unchanging for every Omeka installation. . This lets users log in at www.example.com, and still be logged in at example.com.

1.0

Omeka 1.0 was released on June 2, 2009.

What's New in Omeka 1.0?

• UI Improvements
  • File metadata page on public themes
  • Autocomplete for tags
  • Pagination, filtering and sorting on the users admin panel
  • Upgrade notification when new version is released
  • 'Remember Me' option when logging in
  • JSONP now available for JSON outputs
• Compatibility with 0.10
  • Minor changes to config.ini
  • Removed many deprecated helper functions
  • Changed Dublin Core form inputs
• API improvements
  • Plugin API
    • New plugin API functions for item/file/collection ingest: insert_item, update_item, insert_files_for_item, insert_collection, insert_files_for_item, insert_element_set
• Theme API
  • Additional options/arguments for display_files, including built in display of icons for specific file types
  • New helpers for file metadata page: item_file, show_file_metadata, link_to_file_metadata
  • Additional options for show_item_metadata()
  • Additional argument for item()
  • Additional argument for select_item_type, select_item_type_elements, select_element, select_user(), select_entity()
• Miscellaneous
  • release\_object() to help solve memory leak issues
• Security fixes
  • Command Injection with ImageMagick
  • Default JSON outputs
• Internal changes
  • Overhaul of File model
  • Upgraded to Zend Framework 1.7.5
• List of bug fixes

UI Improvements

• trac#485, adds a file metadata page that will display on every public theme. This displays Dublin Core and other element metadata for the files that are attached to items. This can be accessed at the following relative URL in any Omeka installation: 'files/show/id', where ID is the unique numeric ID for the file (similar to items). See #Theme API improvements for more details.

• trac#352, adds pagination capabilities to table classes and controllers. Omeka admin panel now shows pagination for lists of collections and users. Plugins can also use these improvements to implement pagination in a clean and simple fashion.

• trac#65, implements autocomplete for adding tags via the admin interface.

• trac#489, adds filtering/sorting criteria for users. Site administrators can now sort by username, first/last name, institution name, role, status (active/inactive). Can filter by role or status.

• trac#459, adds an upgrade notification to the admin dashboard to tell users when a new version of Omeka is available (with a corresponding helper function, get_latest_omeka_version.

• trac#158, enables JSONP for auto-serialized JSON requests. The javascript callback can be provided via the optional 'callback' parameter for any JSON request (output=json). JSONP responses are given the 'text/javascript' MIME type. This is different from the regular JSON MIME type ('application/json').

• trac#154, adds a 'Remember Me' option to the login form. This will maintain a user's session for 2 weeks from the moment of login. If 'Remember' is not checked, the session will expire when the browser session terminates.

  • This also adds a 'session.name' field to the config.ini file and removes the pre-existing 'login.expire' setting. See Compatibility Issues for more details. If session name is not provided in the config file, the default session name will be automatically generated from the WEB_ROOT of the installation. A common use case for customizing the session name is so that session data could be shared across Omeka installations or with other applications running on the same server.
  • Also added an 'initializeSession' phase to Omeka_Core, so that the session name could be properly configured prior to requests.

Compatibility issues with 0.10

• 'login.expire' setting was removed from the config.ini file. If you rely on this setting for determining the length of user sessions, tell your users instead to check 'Remember Me' when logging in through the admin. That is the same as setting login.expire to 2 weeks, and having the option of not extending the session is more secure on public computers.

• Many deprecated helper functions have been removed from the 1.0 release of Omeka. Most of these were non-working as of 0.10, but some may or may not have functioned correctly. In the interests of clarifying the API, these functions will not be available as of 1.0. Using any of these functions within themes or plugins will now cause a fatal error:

  • generate_url($options, $name)
  • dublin_core($type) {
  • metatext_form($item, $input=“textarea”,$metafields=null)
  • items_rss_header()
  • get_month($date)
  • get_day($date)
  • get_year($date)
  • item_metadata($item, $field, $escape=true)
  • type($id=null)
  • types(array $params = array())
  • tags(array $params = array())
  • items(array $params = array())
  • users(array $params = array())
  • institutions(array $params = array())
  • metafields(array $params = array())
  • people(array $params = array())
  • has_collection($item, $name=null) {
  • has_files($item) {
  • item_types()
  • collections(array $params = array())
  • entities(array $params = array())
  • has_collectors($collection) {
  • has_tags($item, array $tags=array()) {
  • has_thumbnail($item) {
  • has_type($item, $name=null) {
  • display_empty($val, $alternative=“[Empty]”) {
  • get_base_url($use_relative_uri=false)
  • is_current($link, $req = null) {
  • link_to_thumbnail($item, $props=array(), $action='show', $random=false)
  • link_to_fullsize($item, $props=array(), $action='show', $random=false)
  • link_to_square_thumbnail($item, $props=array(), $action='show', $random=false)
  • _link_to_archive_image($item, $props=array(), $action='show', $random=false, $imageType = 'thumbnail')
  • items_rss_uri($params=array())
  • item_permalink_url($item)
  • define_metafield($name, $description, $type=null)
  • add_theme_pages($dir, $theme='both')
  • add_controllers($dir='controllers')
  • add_data_feed($format, $options=array())
  • add_navigation($text, $link, $type='main', $permissions=null)

• [3572] All Dublin Core elements on the items form are now plain text. The 'Language' and 'Date' elements are the ones affected by this change. The logic behind this change is that the previous form inputs (drop menu for language and YYYY/MM/DD date field) did not allow the full range of data entry that is implied by unqualified Dublin Core. In certain situations, data ingested from other systems may not have been possible to edit using Omeka. For example, if a date field containing 'May 10, 1932' was not converted to 1932-05-10 when ingested into the Omeka database, it would not be editable using the Omeka administrative interface.

• The value in 'path_to_convert' is changed from previous versions. This will not affect users with an up-to-date database. See Security Fixes for more details.

API Improvements

Plugin API

• Some helper functions have been added to simplify the task of ingesting data into Omeka from other systems. For more information about these helpers, see the codex or inline code documentation:
  • insert_item($metadata = array(), $elementTexts = array(), $fileMetadata = array())
  • update_item($item, $metadata = array(), $elementTexts = array(), $fileMetadata = array())
  • insert_collection($metadata = array())
  • trac#488, insert_element_set($elementSet, array $elements = array())
  • trac#648, insert_files_for_item($item, $transferStrategy, $files, $options = array())
• [3710] release_object($var): Can be used in plugins to avoid memory leaks. This encapsulates a workaround for PHP's built in garbage collection, which causes memory leaks when objects contain circular references. It does this by explicitly destroying an object instead of relying on PHP's garbage collection. Currently this only has a noticeable impact with record instances (classes extending Omeka_Record), though it may be extended to other classes in the future as needed.
  • Caveats: This will destroy an object before automatic garbage collection would normally take over, so there may still be broken references to that object elsewhere in the application. This could cause problems when two plugins conflict with one another. For example, one plugin could store a reference to an Item record for future use, and a second plugin might release that record using release_object(). In this case, the first plugin would cease to work because of the second plugin's behavior. For this reason, release_object() should be avoided unless a memory leak crashes the plugin or otherwise interferes with its function.
  • Example:

    $item = insert_item(array('public'=>true), array());
    release_object($item);

Theme API

• trac#479, a series of enhancements to display_files():
  • adds 'linkAttributes' and 'imgAttributes' options to display_files(). These are arrays that represent the XHTML attributes in the and tags, if applicable.
  • adds support for displaying icons using display_files(). Users can now pass the 'icons' option as a keyed array of MIME types and paths to the respective icons. Here is a usage example from the code:
  • changes the 3rd argument of display files from a string (class attribute for the wrapping div) to an array (all attributes for the wrapping div). NOTE: This will break themes that rel...