diff --git a/.travis.yml b/.travis.yml
index 84a7665..90eae9a 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -2,6 +2,7 @@ language: php
php:
- 5.3.3
- 5.4
+ - 5.5
branches:
only:
- 7.x
diff --git a/LICENSE.txt b/LICENSE.txt
index dba13ed..94a9ed0 100644
--- a/LICENSE.txt
+++ b/LICENSE.txt
@@ -1,5 +1,5 @@
- GNU AFFERO GENERAL PUBLIC LICENSE
- Version 3, 19 November 2007
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
@@ -7,15 +7,17 @@
Preamble
- The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
-our General Public Licenses are intended to guarantee your freedom to
+the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
-software for all its users.
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
@@ -24,34 +26,44 @@ them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
- Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
- A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate. Many developers of free software are heartened and
-encouraged by the resulting cooperation. However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
- The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community. It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server. Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
- An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals. This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing under
-this license.
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
@@ -60,7 +72,7 @@ modification follow.
0. Definitions.
- "This License" refers to version 3 of the GNU Affero General Public License.
+ "This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
@@ -537,45 +549,35 @@ to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
- 13. Remote Network Interaction; Use with the GNU General Public License.
-
- Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software. This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
+ 13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
+under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero General Public License from time to time. Such new versions
-will be similar in spirit to the present version, but may differ in detail to
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU Affero General
+Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
+GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
+versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
@@ -633,29 +635,40 @@ the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as published by
+ it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
+ GNU General Public License for more details.
- You should have received a copy of the GNU Affero General Public License
+ You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
- If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source. For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code. There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
+For more information on this, and how to apply and follow the GNU GPL, see
.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/README.md b/README.md
index 8615df0..636c940 100644
--- a/README.md
+++ b/README.md
@@ -1,55 +1,67 @@
-BUILD STATUS
-------------
-Current build status:
-[](https://travis-ci.org/Islandora/islandora_bookmark)
+# Islandora Bookmark [](https://travis-ci.org/Islandora/islandora_bookmark)
-CI Server:
-http://jenkins.discoverygarden.ca
+## Introduction
-ISLANDORA BOOKMARK
-==================
+The Islandora Bookmark module allows users to build, manage, share and track lists of objects. Manage your bookmarks under /islandora_bookmark. There are two ways to add bookmarks to your lists:
-SUMMARY
--------
-
-The Islandora Bookmark module allows users to build, manage, share and track lists of objects.
-Manage your bookmarks under /islandora_bookmark. There's two ways to add bookmarks to your lists.
-1) Through object pages: every object page will have a little tool at the bottom to bookmark the
+1. Through object pages: every object page will have a little tool at the bottom to bookmark the
current object.
-2) Through Solr searches: Islandora Bookmark provides a solr display with functionality to
+2. Through Solr searches: Islandora Bookmark provides a SOLR display with functionality to
bookmark objects based on a custom Solr query.
+# Requirements
+
+This module requires the following modules/libraries:
+
+* [Islandora](https://github.com/islandora/islandora)
+* [Tuque](https://github.com/islandora/tuque)
+* [Islandora Solr](https://github.com/islandora/islandora_solr_search) (optional)
+
+
+## Installation
+
+Install as usual, see [this](https://drupal.org/documentation/install/modules-themes/modules-7) for further information.
+
+## Configuration
+
+Configure general bookmark settings in Administration » Islandora » Islandora Utility Modules » Bookmark (admin/islandora/tools/islandora-bookmark).
+
+
+
+Enable 'Bookmark' in Administration » Islandora » Solr index » Solr Settings (admin/islandora/search/islandora_solr/settings).
+
+Set the permissions in Administration » People (admin/people/permissions). There are permissions to administer, use, and share bookmarks. Anonymous users can never share bookmarks.
+
+The admin page has an option to create a default bookmark list for each individual user (Users cannot delete their default lists). The first time you enable default bookmark lists, you will have to log out and log back in before you can view your default list.
+
+If a user is anonymous, adds items to a bookmark list, and then logs in those items will be added to a new list, or appended to their default list.
+
+### Customization
+
+Table cells referencing the bookmarked objects in both bookmark lists and bookmark Solr results can be modified. One way is by overriding the default template file located at `theme/islandora-bookmark-object-display.tpl.php`. Another way is to use `hook_islandora_bookmark_object_markup()` to let another module define the content and markup.
+
+## Troubleshooting/Issues
+
+Having problems or solved a problem? Check out the Islandora google groups for a solution.
-REQUIREMENTS
-------------
+* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)
+* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)
- * Islandora
- * Islandora Solr (optional)
+## FAQ
+Q. How do I set up bookmarking through Solr?
-CONFIGURATION
--------------
+A. Islandora Bookmark provides a Islandora Solr primary display which has to be enabled in the solr client admin page (admin/islandora/search/islandora_solr). To set up Islandora Solr check the module's documentation. Islandora Solr comes with a 'Display switch' block which lets you switch primary displays. When enabled, the bookmark display can be accessed by appending ?display=bookmark to the Solr results URL.
- * General settings can be configured on the admin page at admin/islandora/islandora_bookmark.
- * In the solr client admin page (admin/islandora/search/islandora_solr), enable the Islandora Bookmark
- display profile.
- * Set the permissions: there are permissions to administer, use and share bookmarks. Anonymous users can never
- share bookmarks.
+## Maintainers/Sponsors
+Current maintainers:
-CUSTOMIZATION
--------------
+* [Jordan Dukart](https://github.com/jordandukart)
-Table cells referencing the bookmarked objects in both bookmark lists and bookmark Solr results can be modified.
-One way is by overriding the default template file located at theme/islandora-bookmark-object-display.tpl.php.
-Another way is to use hook_islandora_bookmark_object_markup() to let another module define the content and markup.
+## Development
+If you would like to contribute to this module, please check out our helpful [Documentation for Developers](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers) info, as well as our [Developers](http://islandora.ca/developers) section on the Islandora.ca site.
-TROUBLESHOOTING
----------------
+## License
- * How do I set up bookmarking through Solr?
-
-Islandora Bookmark provides a Islandora Solr primary display which has to be enabled in the solr client admin page
-(admin/islandora/search/islandora_solr). To set up Islandora Solr check the module's documentation. Islandora Solr comes
-with a 'Display switch' block which lets you switch primary displays. When enabled, the bookmark display can be accessed
-by appending ?display=bookmark to the Solr results URL.
\ No newline at end of file
+[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt)
diff --git a/css/list-columns.css b/css/list-columns.css
new file mode 100644
index 0000000..1e1bea5
--- /dev/null
+++ b/css/list-columns.css
@@ -0,0 +1,24 @@
+.islandora-bookmark-list-column {
+ display: inline-block;
+ max-width: 16em;
+ margin: 0.1em;
+ vertical-align: text-top;
+ text-align: center;
+}
+.islandora-bookmark-list-column > div {
+ margin: 0.2em;
+ background-color: #E4E4E4;
+ border-style: solid;
+ border-width: 0.1em;
+}
+.islandora-bookmark-list-column img {
+ max-width: 15em;
+ display: block;
+ /*Center alignment.*/
+ margin-left: auto;
+ margin-right: auto;
+}
+.list-links {
+ float: right;
+ margin: 0.2em;
+}
diff --git a/css/list-links.css b/css/list-links.css
new file mode 100644
index 0000000..1be5bf1
--- /dev/null
+++ b/css/list-links.css
@@ -0,0 +1,4 @@
+.list-links {
+ float: right;
+ margin: 0.2em;
+}
diff --git a/includes/admin.form.inc b/includes/admin.form.inc
index f98b145..c87120d 100644
--- a/includes/admin.form.inc
+++ b/includes/admin.form.inc
@@ -21,6 +21,7 @@ function islandora_bookmark_admin_settings(array $form, array &$form_state) {
'list_type' => array(
'#type' => 'textfield',
'#title' => t('The name of the type of list.'),
+ '#description' => t('The unpluralized name of the type of lists such as bookmark or favorite.'),
'#default_value' => variable_get('islandora_bookmark_type', 'bookmark'),
),
'overview_page_elements' => array(
@@ -39,6 +40,42 @@ function islandora_bookmark_admin_settings(array $form, array &$form_state) {
'#element_validate' => array('element_validate_integer_positive'),
'#size' => 4,
),
+ 'create_user_default_lists' => array(
+ '#type' => 'checkbox',
+ '#title' => t('Create a default list for users?'),
+ '#description' => t('The list will be created the next time they log in.'),
+ '#default_value' => variable_get('islandora_bookmark_create_user_default_lists', FALSE),
+ ),
+ 'default_list_name' => array(
+ '#type' => 'textfield',
+ '#title' => t('Default list name'),
+ '#description' => t("The name of the default user list. To use the user's name in the field use '@username'."),
+ '#default_value' => variable_get('islandora_bookmark_default_list_name', "@username's Default List"),
+ '#states' => array(
+ 'visible' => array(
+ ':input[name="create_user_default_lists"]' => array('checked' => TRUE),
+ ),
+ ),
+ ),
+ 'share_with_everyone' => array(
+ '#type' => 'checkbox',
+ '#title' => t('Share new default lists with everyone?'),
+ '#default_value' => variable_get('islandora_bookmark_share_default_list', FALSE),
+ '#states' => array(
+ 'visible' => array(
+ ':input[name="create_user_default_lists"]' => array('checked' => TRUE),
+ ),
+ ),
+ ),
+ 'islandora_bookmark_default_list_view' => array(
+ '#type' => 'select',
+ '#title' => t('Default bookmark list view.'),
+ '#default_value' => variable_get('islandora_bookmark_default_list_view', 'manage'),
+ '#options' => array(
+ 'manage' => t('Administration Table'),
+ 'islandora_bookmark_list_columns' => t('Columns'),
+ ),
+ ),
'submit' => array(
'#type' => 'submit',
'#value' => t('Save configuration'),
@@ -48,10 +85,25 @@ function islandora_bookmark_admin_settings(array $form, array &$form_state) {
'#value' => t('Reset to defaults'),
),
);
-
return $form;
}
+/**
+ * Validation function for the Bookmark admin form.
+ *
+ * @param array $form
+ * The Drupal form definition.
+ * @param array $form_state
+ * The Drupal form state.
+ */
+function islandora_bookmark_admin_settings_validate(array $form, array &$form_state) {
+ if ($form_state['triggering_element']['#id'] != 'edit-reset' && $form_state['values']['create_user_default_lists']) {
+ if (empty($form_state['values']['default_list_name'])) {
+ form_set_error('default_list_name', t('Please provide a name for default user lists.'));
+ }
+ }
+}
+
/**
* Function that sets the Drupal variables with user's input.
*
@@ -68,12 +120,22 @@ function islandora_bookmark_admin_settings_submit(array $form, array &$form_stat
variable_set('islandora_bookmark_overview_page_elements', $form_state['values']['overview_page_elements']);
variable_set('islandora_bookmark_detailed_page_elements', $form_state['values']['detailed_page_elements']);
variable_set('islandora_bookmark_type', $form_state['values']['list_type']);
+ variable_set('islandora_bookmark_create_user_default_lists', $form_state['values']['create_user_default_lists']);
+ if ($form_state['values']['create_user_default_lists']) {
+ variable_set('islandora_bookmark_default_list_name', $form_state['values']['default_list_name']);
+ variable_set('islandora_bookmark_share_default_list', $form_state['values']['share_with_everyone']);
+ }
+ variable_set('islandora_bookmark_default_list_view', $form_state['values']['islandora_bookmark_default_list_view']);
break;
case 'edit-reset':
variable_del('islandora_bookmark_overview_page_elements');
variable_del('islandora_bookmark_detailed_page_elements');
variable_del('islandora_bookmark_type');
+ variable_del('islandora_bookmark_create_user_default_lists');
+ variable_del('islandora_bookmark_default_list_name');
+ variable_del('islandora_bookmark_share_default_list');
+ variable_del('islandora_bookmark_default_list_view');
break;
}
}
diff --git a/includes/api.inc b/includes/api.inc
index de81896..464cf52 100644
--- a/includes/api.inc
+++ b/includes/api.inc
@@ -8,7 +8,7 @@
/**
* Retrieves lists that the specified user has access to.
*
- * @global type $user
+ * @global stdClass $user
*
* @return array
* An array of PidList objects.
@@ -27,19 +27,24 @@ function islandora_bookmark_get_user_owned_bookmarks() {
}
// User is anon, use session as well.
- if (isset($_SESSION) && $user->uid == 0 && !empty($_SESSION['islandora_bookmark'])) {
- foreach (array_keys($_SESSION['islandora_bookmark']) as $id) {
- $bookmark_list[] = BookmarkSession::getList($id);
+ if ($user->uid == 0) {
+ if (!isset($_SESSION) || empty($_SESSION['islandora_bookmark']) && variable_get('islandora_bookmark_create_user_default_lists', FALSE)) {
+ BookmarkDefaultSessionList::createNewList(t('My Default List'), 'bookmark_default', $user);
}
- }
+ if (!empty($_SESSION['islandora_bookmark'])) {
+ foreach (array_keys($_SESSION['islandora_bookmark']) as $id) {
+ $bookmark_list[] = BookmarkSession::getList($id);
+ }
+ }
+ }
return $bookmark_list;
}
/**
* Retrieves all Bookmarks the current user is shared on.
*
- * @global type $user
+ * @global stdClass $user
* @return array
* An array of Bookmarks.
*/
@@ -72,12 +77,12 @@ function islandora_bookmark_get_user_shared_bookmarks() {
/**
* Retrieves a Bookmark given a specified ID.
*
- * @global type $user
+ * @global stdClass $user
*
* @param int $listid
* List ID to be searched for.
*
- * @return bool|PidList
+ * @return bool|Bookmark
* PidList object or FALSE if the list does not exist.
*/
function islandora_bookmark_get_bookmark_by_number($listid) {
@@ -102,21 +107,26 @@ function islandora_bookmark_get_bookmark_by_number($listid) {
function islandora_bookmark_get_bookmarks_visible_to_user($pid, $uid) {
$lists = array();
// SESSION FIRST.
- if ($uid == 0 && !empty($_SESSION['islandora_bookmark'])) {
- foreach ($_SESSION['islandora_bookmark'] as $value) {
- $templist = $value;
- if (in_array($pid, $templist->getPids())) {
- $lists[$templist->getId()] = $templist->getId();
+ if ($uid == 0) {
+ if (!isset($_SESSION) || empty($_SESSION['islandora_bookmark']) && variable_get('islandora_bookmark_create_user_default_lists', FALSE)) {
+ BookmarkDefaultSessionList::createNewList(t('My Default List'), 'bookmark_default', NULL);
+ }
+ if (isset($_SESSION['islandora_bookmark'])) {
+ foreach ($_SESSION['islandora_bookmark'] as $value) {
+ $templist = $value;
+ if (in_array($pid, $templist->getPids())) {
+ $lists[$templist->getId()] = $templist->getId();
+ }
}
}
}
else {
// DB.
$q = << $uid, ':pid' => $pid))
@@ -155,3 +165,34 @@ function islandora_bookmark_list_users_query($value) {
$users[] = $list->bookmarkOwner;
return $users;
}
+
+/**
+ * Determines whether the user has a BookmarkDefaultDatabaseList or not.
+ *
+ * @param object $user
+ * Optional user object if we are checking for a specific user.
+ *
+ * @return int|bool
+ * The ID of the list if they do have one, FALSE otherwise.
+ */
+function islandora_bookmark_get_default_list($user = NULL) {
+ if ($user === NULL) {
+ global $user;
+ }
+ elseif (!is_object($user) || !isset($user->uid)) {
+ return FALSE;
+ }
+ $result = db_query('SELECT listid FROM {islandora_bookmark_list_names} WHERE listowner = :owner AND type = :type',
+ array(
+ ':owner' => $user->uid,
+ ':type' => 'bookmark_default',
+ )
+ );
+ $total_results = $result->fetchField();
+ if (empty($total_results)) {
+ return FALSE;
+ }
+ else {
+ return $total_results;
+ }
+}
diff --git a/includes/bookmark.inc b/includes/bookmark.inc
index 3af053f..38f36e7 100644
--- a/includes/bookmark.inc
+++ b/includes/bookmark.inc
@@ -9,6 +9,7 @@
* Interface defining the base operations required to implement a backend.
*/
interface BookmarkInterface {
+
/**
* Adds the specified PID to the given list.
*
@@ -20,6 +21,12 @@ interface BookmarkInterface {
/**
* Get PIDs associated with this list.
*
+ * @param int $offset
+ * The starting offset of pids to retrieve.
+ *
+ * @param int $limit
+ * The number of pids to retrieve.
+ *
* @return array
* An array of string, each representing an ID in a list.
*/
@@ -71,6 +78,7 @@ interface BookmarkInterface {
* constructed such that it contains a listname and listid for uniqueness.
*/
abstract class Bookmark implements BookmarkInterface {
+
/**
* The name of the object.
*
@@ -78,6 +86,13 @@ abstract class Bookmark implements BookmarkInterface {
*/
public $bookmarkName;
+ /**
+ * The description of the object.
+ *
+ * @var string
+ */
+ public $bookmarkDescription;
+
/**
* The owner of the object.
*
@@ -99,53 +114,22 @@ abstract class Bookmark implements BookmarkInterface {
*/
protected $isPersistent;
+ /**
+ * Flag whether the object can be deleted or not.
+ *
+ * @var bool
+ */
+ protected $isDeletable;
+
/**
* Constructor for the Bookmark object.
*/
- public function __construct($id, $name, $owner) {
+ public function __construct($id, $name, $owner, $desc = "") {
$this->bookmarkId = $id;
$this->bookmarkName = $name;
$this->bookmarkOwner = $owner;
- }
-
- /**
- * Somewhat more graceful deprecation of old properties.
- */
- public function __get($property) {
- if ($property == 'userList') {
- module_load_include('inc', 'islandora', 'includes/utilities');
- $message = islandora_deprecated('7.x-1.3', 'Use the methods {get,add,remove}Users(), instead of accessing as a property.');
- trigger_error(filter_xss($message), E_USER_DEPRECATED);
- return $this->getUsers();
- }
- elseif ($property == 'pidList') {
- module_load_include('inc', 'islandora', 'includes/utilities');
- $message = islandora_deprecated('7.x-1.3', 'Use the methods {get,add,remove}Pids(), instead of accessing as a property.');
- trigger_error(filter_xss($message), E_USER_DEPRECATED);
- return $this->getPids();
- }
- }
-
- /**
- * Somewhat more graceful deprecation of old properties.
- */
- public function __set($property, $value) {
- if ($property == 'userList') {
- module_load_include('inc', 'islandora', 'includes/utilities');
- $message = islandora_deprecated('7.x-1.3', 'Use the methods {get,add,remove}Users(), instead of accessing as a property.');
- trigger_error(filter_xss($message), E_USER_DEPRECATED);
- $this->removeUsers($this->getUsers());
- $this->addUsers($value);
- return $value;
- }
- elseif ($property == 'pidList') {
- module_load_include('inc', 'islandora', 'includes/utilities');
- $message = islandora_deprecated('7.x-1.3', 'Use the methods {get,add,remove}Pids(), instead of accessing as a property.');
- trigger_error(filter_xss($message), E_USER_DEPRECATED);
- $this->removeAllPids();
- $this->addPids($value);
- return $value;
- }
+ $this->bookmarkDescription = $desc;
+ $this->isDeletable = TRUE;
}
/**
@@ -168,6 +152,16 @@ abstract class Bookmark implements BookmarkInterface {
return $this->isPersistent;
}
+ /**
+ * Accessor for whether the object is deletable.
+ *
+ * @return mixed
+ * The value of $this->isDeletable.
+ */
+ public function getIsDeletable() {
+ return $this->isDeletable;
+ }
+
/**
* Get the given (existing) list.
*
@@ -192,7 +186,6 @@ abstract class Bookmark implements BookmarkInterface {
// Pass off to BookmarkDatabase.
$bookmark = BookmarkDatabase::getList($id, FALSE);
}
-
return $bookmark;
}
@@ -259,7 +252,6 @@ abstract class Bookmark implements BookmarkInterface {
* An array of strings, representing object PIDs.
*/
public function addPids($pids) {
- $pids = array_filter($pids, 'islandora_object_load');
foreach ($pids as $pid) {
$this->addPid($pid);
}
@@ -285,15 +277,20 @@ abstract class Bookmark implements BookmarkInterface {
*
* @param string $name
* A name for the newly created list.
+ * @param string $desc
+ * An optional description for the list.
+ *
+ * @return BookmarkSession|BookmarkDatabase
+ * The BookmarkSession or BookmarkDatabase object that is created.
*/
- public static function createNewList($name) {
+ public static function createNewList($name, $desc = "") {
global $user;
if ($user->uid === 0) {
- return BookmarkSession::createNewList($name);
+ return BookmarkSession::createNewList($name, NULL, $desc);
}
else {
- return BookmarkDatabase::createNewList($name);
+ return BookmarkDatabase::createNewList($name, 'bookmark', NULL, $desc);
}
}
@@ -316,6 +313,16 @@ abstract class Bookmark implements BookmarkInterface {
$this->bookmarkName = $name;
}
+ /**
+ * Changes the description of the object in the session or the database.
+ *
+ * @param string $description
+ * The new description of the object.
+ */
+ public function changeDescription($description) {
+ $this->bookmarkDescription = $description;
+ }
+
/**
* Check if user can execute management functions on the current Bookmark.
*
@@ -357,12 +364,10 @@ abstract class Bookmark implements BookmarkInterface {
* theme_tableselect().
*/
protected function getTableHeader() {
- $header = array('markup' => array('data' => t('Label')));;
-
+ $header = array('markup' => array('data' => t('Label')));
if ($this->managementAccess()) {
$header['remove'] = array('data' => t('Operations'));
}
-
return $header;
}
@@ -388,7 +393,6 @@ abstract class Bookmark implements BookmarkInterface {
'#button_type' => 'submit',
'#pid' => $pid,
'#value' => t('Remove'),
-
);
$row['remove'] = array(
'data' => drupal_render($remove_button),
@@ -403,7 +407,6 @@ abstract class Bookmark implements BookmarkInterface {
* Form building method.
*/
public function formGet($form, &$form_state) {
- global $user;
if (module_exists('citation_exporter')) {
if (CitationExporter::ReadyToExport()) {
$citation_export_head = array(
@@ -438,22 +441,11 @@ abstract class Bookmark implements BookmarkInterface {
),
);
- // This is the RSS icon link.
- if ($this->getIsPersistent() && $this->getPidCount() > 0) {
- $id = $this->getId();
- $form['bookmark_rss'] = array(
- '#weight' => -1,
- '#markup' => l(theme('image', array(
- 'path' => drupal_get_path('module', 'islandora_bookmark') . '/images/rss.png',
- 'title' => t('Present Bookmark list in RSS form'),
- 'attributes' => array(),
- )), "islandora-bookmark/listid/$id/rss", array('html' => TRUE)),
- '#prefix' => '
',
- '#suffix' => '
',
- );
- }
-
- $rows = array();
+ // This is the list links.
+ $form['bookmark_list_links'] = theme(
+ 'islandora_bookmark_list_links',
+ array('bookmark_id' => $this->bookmarkId, 'current' => 'manage')
+ );
// Do pager calcuations to limit the number of objects displayed per page.
$num_eles = variable_get('islandora_bookmark_detailed_page_elements', 10);
@@ -469,8 +461,8 @@ abstract class Bookmark implements BookmarkInterface {
$form['bookmarks']['fieldset'] += array(
'table' => $table += array(
'#empty' => t('@type list is empty.', array(
- '@type' => ucwords(variable_get('islandora_bookmark_type', 'bookmark')),
- )),
+ '@type' => ucwords(variable_get('islandora_bookmark_type', 'bookmark')),
+ )),
'#weight' => -2,
),
'pager' => array(
@@ -496,6 +488,8 @@ abstract class Bookmark implements BookmarkInterface {
*
* @param array $container
* A reference to a part of the form, where the actions should be added.
+ * @param array $form_state
+ * The Drupal form state.
*/
protected function formAddActions(&$container, &$form_state) {
$groups = array();
@@ -526,11 +520,22 @@ abstract class Bookmark implements BookmarkInterface {
$export_styles = array();
$export = islandora_bookmark_get_export_options();
$export_options['default'] = t('- Export type -');
-
+ // As export options can be user configurable and want to maintain
+ // human readability through the UI need to account for the fact that
+ // some options could have spaces in them. If spaces are encountered in
+ // the $_POST Drupal will not pick them up in the form state values.
+ // As such two formats can be used one which specifics a callable
+ // and a human-readable pair and the old form.
foreach ($export as $module_name => $export_array) {
foreach ($export_array as $name => $export_func) {
- $export_options[t("@module_name", array("@module_name" => $module_name))][$name] = $name;
- $form_state['islandora_bookmark_export'][$name] = $export_func;
+ if (is_callable($export_func)) {
+ $export_options[t("@module_name", array("@module_name" => $module_name))][$name] = $name;
+ $form_state['islandora_bookmark_export'][$name] = $export_func;
+ }
+ else {
+ $export_options[t("@module_name", array("@module_name" => $module_name))][$name] = $export_func['human_readable'];
+ $form_state['islandora_bookmark_export'][$name] = $export_func['callable'];
+ }
$export_styles[$name] = islandora_bookmark_get_export_format_options($name);
}
}
@@ -543,7 +548,6 @@ abstract class Bookmark implements BookmarkInterface {
'#title' => t('Style'),
'#options' => $value,
'#weight' => 0,
- '#name' => 'islandora_bookmark_export_styles_' . $key,
'#states' => array(
'visible' => array(
':input[name="bookmarks[fieldset][export_options]"]' => array('value' => $key),
@@ -644,12 +648,11 @@ abstract class Bookmark implements BookmarkInterface {
else {
$output_user = user_load($remove_user)->name;
}
- drupal_set_message(t('The user @username has been removed from the list @listname.',
- array(
- '@listname' => $this->bookmarkName,
- '@username' => $output_user,
- )
- ));
+ drupal_set_message(t('The user @username has been removed from the list @listname.', array(
+ '@listname' => $this->bookmarkName,
+ '@username' => $output_user,
+ )
+ ));
$this->removeUsers(array($remove_user));
}
}
@@ -730,11 +733,11 @@ abstract class Bookmark implements BookmarkInterface {
}
// Get all users for use in select for forms.
$result = db_select('users', 'u')
- ->fields('u', array('uid', 'name'))
- ->condition('STATUS', 0, '!=')
- ->condition('uid', $user->uid, '!=')
- ->orderBy('uid')
- ->execute();
+ ->fields('u', array('uid', 'name'))
+ ->condition('STATUS', 0, '!=')
+ ->condition('uid', $user->uid, '!=')
+ ->orderBy('uid')
+ ->execute();
$options += $result->fetchAllAssoc('uid', PDO::FETCH_ASSOC);
if (isset($options['0'])) {
@@ -811,7 +814,7 @@ abstract class Bookmark implements BookmarkInterface {
/**
* Submission callback; export the selected PIDs.
*/
- protected function formExportSelected($form, $form_state) {
+ protected function formExportSelected(&$form, &$form_state) {
$pids = $this->formGetSelected($form_state);
$this->formExport($pids, $form_state);
}
@@ -819,7 +822,7 @@ abstract class Bookmark implements BookmarkInterface {
/**
* Submission callback; export all PIDs in the list.
*/
- protected function formExportAll($form, $form_state) {
+ protected function formExportAll(&$form, &$form_state) {
$pids = $this->formGetAll($form_state);
$this->formExport($pids, $form_state);
}
@@ -830,30 +833,29 @@ abstract class Bookmark implements BookmarkInterface {
protected function formExport($pids, $form_state) {
$el = $form_state['complete form']['bookmarks']['fieldset']['export_options'];
$key = drupal_array_get_nested_value($form_state['values'], $el['#parents']);
-
$params = array(
$pids,
);
-
- if (array_key_exists('islandora_bookmark_export_styles_' . $key, $form_state['input'])) {
- $params[] = $form_state['input']['islandora_bookmark_export_styles_' . $key];
+ if (isset($form_state['values']['bookmarks']['fieldset']['format_opts']['export_styles'])) {
+ if (array_key_exists($key, $form_state['values']['bookmarks']['fieldset']['format_opts']['export_styles'])) {
+ $params[] = $form_state['values']['bookmarks']['fieldset']['format_opts']['export_styles'][$key];
+ }
}
-
call_user_func_array($form_state['islandora_bookmark_export'][$key], $params);
}
/**
* Submission callback; remove the selected PIDs from the list.
*/
- protected function formRemoveSelectedFromList($form_state) {
- $pids = $this->formGetAll($form_state);
+ protected function formRemoveSelectedFromList(&$form, &$form_state) {
+ $pids = $this->formGetSelected($form_state);
$this->formRemoveFromList($pids, $form_state);
}
/**
* Submission callback; remove all PIDs from the list.
*/
- protected function formRemoveAllFromList($form_state) {
+ protected function formRemoveAllFromList(&$form, &$form_state) {
$pids = $this->formGetAll($form_state);
$this->formRemoveFromList($pids, $form_state);
}
@@ -895,6 +897,9 @@ abstract class Bookmark implements BookmarkInterface {
/**
* Get the PIDs of any single remove button(s).
*
+ * @param array $form_state
+ * The Drupal form state.
+ *
* @return array
* An array of PIDs--may be empty if there are none present.
*/
@@ -929,9 +934,7 @@ abstract class Bookmark implements BookmarkInterface {
$errors = form_get_errors();
if (count($errors) === 0) {
$page = pager_default_initialize(
- $this->getPidCount(),
- variable_get('islandora_bookmark_detailed_page_elements', 10),
- $form_state['islandora_bookmark_pager_element']
+ $this->getPidCount(), variable_get('islandora_bookmark_detailed_page_elements', 10), $form_state['islandora_bookmark_pager_element']
);
$form_state['redirect'] = array(
@@ -957,7 +960,7 @@ abstract class Bookmark implements BookmarkInterface {
if (!empty($broken)) {
watchdog('islandora_bookmark', 'Broken PIDs encountered: @pids', array(
'@pids' => implode(', ', $broken),
- ), WATCHDOG_WARNING);
+ ), WATCHDOG_WARNING);
}
return $functional;
@@ -973,9 +976,10 @@ abstract class Bookmark implements BookmarkInterface {
if (!empty($broken)) {
watchdog('islandora_bookmark', 'Broken PIDs encountered: @pids', array(
'@pids' => implode(', ', $broken),
- ), WATCHDOG_WARNING);
+ ), WATCHDOG_WARNING);
}
return $functional;
}
+
}
diff --git a/includes/bookmark_db.inc b/includes/bookmark_db.inc
index c159d89..e12a5ee 100644
--- a/includes/bookmark_db.inc
+++ b/includes/bookmark_db.inc
@@ -19,10 +19,11 @@ class BookmarkDatabase extends Bookmark {
'bookmarkName' => 'listname',
'bookmarkOwner' => 'listowner',
'type' => 'type',
+ 'bookmarkDescription' => 'descrip',
);
/**
- * Constructor for the Bookmark object.
+ * Constructor for the BookmarkDatabase object.
*/
public function __construct($list_id) {
parent::__construct($list_id, NULL, NULL);
@@ -164,25 +165,28 @@ class BookmarkDatabase extends Bookmark {
* @param object $owner
* A user object from which we can grab the uid. If not provided, we'll
* grab the global "$user" variable.
+ * @param string $desc
+ * An optional description of the bookmark list.
*
* @return BookmarkDatabase
* A new Bookmark object.
*/
- public static function createNewList($name, $type = 'bookmark', $owner = NULL) {
+ public static function createNewList($name, $type = 'bookmark', $owner = NULL, $desc = '') {
if ($owner === NULL) {
global $user;
$owner = $user;
}
+ drupal_alter(ISLANDORA_BOOKMARK_DATABASE_LIST_CREATION_HOOK, $name, $type, $owner, $desc);
$fields = array(
'listname' => $name,
'listowner' => $owner->uid,
'type' => $type,
+ 'descrip' => $desc,
);
$list_id = db_insert('islandora_bookmark_list_names')
->fields($fields)
->execute();
-
return static::getList($list_id, FALSE);
}
diff --git a/includes/bookmark_default_db.inc b/includes/bookmark_default_db.inc
new file mode 100644
index 0000000..03476c9
--- /dev/null
+++ b/includes/bookmark_default_db.inc
@@ -0,0 +1,28 @@
+isDeletable = FALSE;
+ }
+
+ /**
+ * Overwrite to do nothing...
+ */
+ public function delete() {
+
+ }
+}
diff --git a/includes/bookmark_default_session.inc b/includes/bookmark_default_session.inc
new file mode 100644
index 0000000..223f78f
--- /dev/null
+++ b/includes/bookmark_default_session.inc
@@ -0,0 +1,28 @@
+isDeletable = FALSE;
+ }
+
+ /**
+ * Overwrite to do nothing...
+ */
+ public function delete() {
+
+ }
+}
diff --git a/includes/bookmark_rss.inc b/includes/bookmark_rss.inc
index 555c7de..563eec7 100644
--- a/includes/bookmark_rss.inc
+++ b/includes/bookmark_rss.inc
@@ -93,9 +93,9 @@ function islandora_bookmark_create_rss_item(AbstractObject $object) {
* Function for setting the values of the elements for the default RSS.
*
* @tutorial http://feed2.w3.org/docs/rss2.html#hrelementsOfLtitemgt
- *
+ *
* @tutorial http://feed2.w3.org/docs/rss2.html#requiredChannelElements
- *
+ *
* @param AbstractObject $object
* An abstract object
*
diff --git a/includes/bookmark_session.inc b/includes/bookmark_session.inc
index 6363385..ea826bb 100644
--- a/includes/bookmark_session.inc
+++ b/includes/bookmark_session.inc
@@ -33,19 +33,20 @@ class BookmarkSession extends Bookmark {
}
/**
- * Constructor for the Bookmark object.
+ * Constructor for the BookmarkSession object.
*/
- public function __construct($name) {
+ public function __construct($name, $desc = '') {
global $user;
parent::__construct(static::getKey($name), $name, $user->uid);
$this->pidList = array();
$this->isPersistent = FALSE;
+ $this->bookmarkDescription = $desc;
}
/**
* Inherits.
*/
- public static function getList($id) {
+ public static function getList($id, $force_session_attempt = FALSE) {
if (isset($_SESSION['islandora_bookmark'][$id])) {
return $_SESSION['islandora_bookmark'][$id];
}
@@ -72,11 +73,13 @@ class BookmarkSession extends Bookmark {
* @param object $owner
* A user object from which we can grab the uid. If not provided, we'll
* grab the global "$user" variable.
+ * @param string $desc
+ * An optional description of the bookmark list.
*
* @return BookmarkDatabase
* A new Bookmark object.
*/
- public static function createNewList($name, $owner = NULL) {
+ public static function createNewList($name, $owner = NULL, $desc = '') {
if ($owner === NULL) {
global $user;
$owner = $user;
@@ -84,7 +87,7 @@ class BookmarkSession extends Bookmark {
$list_id = static::getKey($name);
- $_SESSION['islandora_bookmark'][$list_id] = new static($name);
+ $_SESSION['islandora_bookmark'][$list_id] = new static($name, $desc);
return static::getList($list_id);
}
diff --git a/includes/solr_results.inc b/includes/solr_results.inc
index a8d30f6..8292c3a 100644
--- a/includes/solr_results.inc
+++ b/includes/solr_results.inc
@@ -53,10 +53,8 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
* An array containing form structure.
*/
public function formGet($form, &$form_state, $object_results) {
- $form_state['islandora_solr_query_processor'] = $this->islandoraSolrQueryProcessor;
module_load_include('inc', 'islandora_bookmark', 'includes/api');
-
- form_load_include($form_state, 'inc', 'islandora_bookmark', 'IslandoraSolrResultsBookmark');
+ $form_state['islandora_solr_query_processor'] = $this->islandoraSolrQueryProcessor;
if (module_exists('citation_exporter')) {
if (CitationExporter::ReadyToExport()) {
@@ -75,8 +73,7 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
$header = $this->getTableHeader();
$rows = array();
foreach ($object_results as $object_result) {
- $doc = $object_result['solr_doc'];
- $rows[$doc['PID']] = $this->getTableRow($object_result);
+ $rows[$object_result['PID']] = $this->getTableRow($object_result);
}
if (count($rows) > 0) {
@@ -117,13 +114,13 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
*/
protected function getTableRow($object_result) {
$doc = $object_result['solr_doc'];
-
+ $solr_field = variable_get('islandora_solr_object_label_field', 'fgs_label_s');
$markup = '';
- if (isset($doc['object_label'])) {
- $markup = $doc['object_label'];
+ if (isset($doc[$solr_field])) {
+ $markup = $doc[$solr_field];
}
else {
- $markup = $doc['PID'];
+ $markup = $object_result['PID'];
}
$object_url_info = array(
@@ -133,13 +130,16 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
);
return array(
- 'markup' => islandora_bookmark_generate_markup($doc['PID'], $object_url_info),
+ 'markup' => islandora_bookmark_generate_markup($object_result['PID'], $object_url_info),
);
}
/**
* Get the "actions" section of the form.
*
+ * @param array $form_state
+ * The Drupal form state.
+ *
* @return array
* A form fragment containing a number of actions which might be performed
* on objects from the table select.
@@ -159,9 +159,21 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
$export_options['default'] = t('- Export type -');
$export_styles = array();
foreach ($export as $module_name => $export_array) {
+ // As export options can be user configurable and want to maintain
+ // human readability through the UI need to account for the fact that
+ // some options could have spaces in them. If spaces are encountered in
+ // the $_POST Drupal will not pick them up in the form state values.
+ // As such two formats can be used one which specifics a callable
+ // and a human-readable pair and the old form.
foreach ($export_array as $name => $export_func) {
- $export_options[$module_name][$name] = $name;
- $form_state['islandora_bookmark_export'][$name] = $export_func;
+ if (is_callable($export_func)) {
+ $export_options[t("@module_name", array("@module_name" => $module_name))][$name] = $name;
+ $form_state['islandora_bookmark_export'][$name] = $export_func;
+ }
+ else {
+ $export_options[t("@module_name", array("@module_name" => $module_name))][$name] = $export_func['human_readable'];
+ $form_state['islandora_bookmark_export'][$name] = $export_func['callable'];
+ }
$export_styles[$name] = islandora_bookmark_get_export_format_options($name);
}
}
@@ -182,7 +194,6 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
'#title' => t('Style'),
'#options' => $export_styles[$key],
'#weight' => 4,
- '#name' => 'islandora_bookmark_export_styles_' . $key,
'#states' => array(
'visible' => array(
':input[name="export_options"]' => array('value' => $key),
@@ -328,10 +339,12 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
*
* Export all PIDs the search yielded.
*
+ * @param array $form
+ * The array representing a Drupal form.
* @param array $form_state
* The array of form state.
*/
- protected function exportAll(&$form_state) {
+ protected function exportAll(&$form, &$form_state) {
$pids = $this->getAll($form_state);
$this->export($pids, $form_state);
}
@@ -341,10 +354,12 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
*
* Export the selected PIDs the search yielded.
*
+ * @param array $form
+ * The array representing a Drupal form.
* @param array $form_state
* The array of form state.
*/
- protected function exportSelected(&$form_state) {
+ protected function exportSelected(&$form, &$form_state) {
$pids = $this->getSelected($form_state);
$this->export($pids, $form_state);
}
@@ -364,9 +379,8 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
$params = array(
$pids,
);
-
- if (array_key_exists('islandora_bookmark_export_styles_' . $key, $form_state['input'])) {
- $params[] = $form_state['input']['islandora_bookmark_export_styles_' . $key];
+ if (array_key_exists($key, $form_state['values'])) {
+ $params[] = $form_state['values'][$key];
}
call_user_func_array($form_state['islandora_bookmark_export'][$key], $params);
@@ -377,10 +391,12 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
*
* Redirect to the given list.
*
+ * @param array $form
+ * The array representing a Drupal form.
* @param array $form_state
* The array of form state.
*/
- protected function goToBookmark(&$form_state) {
+ protected function goToBookmark(&$form, &$form_state) {
$el = $form_state['complete form']['islandora_bookmark_save_fieldset']['fieldset']['save_options'];
$key = drupal_array_get_nested_value($form_state['values'], $el['#parents']);
drupal_goto('islandora-bookmark/listid/' . $key);
@@ -391,10 +407,12 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
*
* Save all PIDs the search yielded to the selected list.
*
+ * @param array $form
+ * The array representing a Drupal form.
* @param array $form_state
* The array of form state.
*/
- protected function saveAll(&$form_state) {
+ protected function saveAll(&$form, &$form_state) {
$pids = $this->getAll($form_state);
$this->save($pids, $form_state);
}
@@ -404,10 +422,12 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
*
* Save the selected PIDs the search yielded to the selected list.
*
+ * @param array $form
+ * The array representing a Drupal form.
* @param array $form_state
* The array of form state.
*/
- protected function saveSelected(&$form_state) {
+ protected function saveSelected(&$form, &$form_state) {
$pids = $this->getSelected($form_state);
$this->save($pids, $form_state);
}
@@ -452,8 +472,8 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
if (count($skipped_pids) > 0) {
drupal_set_message(format_plural(
count($skipped_pids),
- 'The selected object (!skipped_pids) was not added as it already exists in the bookmark list "@listname".',
- 'The selected objects (!skipped_pids) were not added as they already exist in the bookmark list "@listname".',
+ 'The selected object (@skipped_pids) was not added as it already exists in the bookmark list "@listname".',
+ 'The selected objects (@skipped_pids) were not added as they already exist in the bookmark list "@listname".',
array(
'@skipped_pids' => implode(' ', $skipped_pids),
'@listname' => $bookmark_object->bookmarkName,
@@ -491,7 +511,7 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
$clicked_button = $form_state['clicked_button'];
if (isset($clicked_button['#action_submit'])) {
- $params = array(&$form_state);
+ $params = array(&$form, &$form_state);
foreach ((array) $clicked_button['#action_submit'] as $submit_function) {
call_user_func_array(array($this, $submit_function), $params);
}
@@ -506,11 +526,13 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
// Helper anonymous function... Just get the PID.
$get_pid = function($result) {
- $doc = $result['solr_doc'];
- return $doc['PID'];
+ return $result['PID'];
};
$qp = $this->islandoraSolrQueryProcessor;
+ $old_params = $qp->solrParams;
+ $qp->solrParams['fl'] = 'PID';
+ $qp->solrStart = 0;
$qp->solrLimit = 10000;
// Handle the first set separately, so we can get the total number for our
@@ -522,6 +544,7 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
$pids = array_map($get_pid, $object_results);
for ($i = $qp->solrLimit; $i < $result_count; $i += $qp->solrLimit) {
+ $qp->solrStart = $i;
$qp->executeQuery();
$solr_results = $qp->islandoraSolrResult;
$object_results = $solr_results['response']['objects'];
@@ -531,6 +554,7 @@ class IslandoraSolrResultsBookmark extends IslandoraSolrResults {
array_map($get_pid, $object_results)
);
}
+ $qp->solrParams = $old_params;
return $pids;
}
diff --git a/islandora_bookmark.api.php b/islandora_bookmark.api.php
index 464311e..206775c 100644
--- a/islandora_bookmark.api.php
+++ b/islandora_bookmark.api.php
@@ -18,6 +18,9 @@ function hook_islandora_bookmark_export_handler() {
/**
* Hook to alter the options returned for exportation.
*
+ * @param array $output
+ * An array in the form of 'module name' => 'export function'.
+ *
* @return array
* Returns an array with the name of the module and the function name to call
* to handle exportation. In the form of 'module name' => 'export function'.
@@ -28,10 +31,37 @@ function hook_islandora_bookmark_export_handler_alter(&$output) {
/**
* Hook to generate markup for displaying a Fedora object within a table.
*
+ * @param AbstractObject $fedora_object
+ * An AbstractObject representing a Fedora object.
+ *
+ * @param array $object_url_info
+ * An associative array contains information to build an anchor tag.
+ * - path: A string containing the path/
+ * - params: An array of paramaters to be passed.
+ * - markup: A string containing the label for the anchor tag.
+ *
* @return array
* Returns an array containing the markup for displaying the Fedora object.
*/
-function hook_islandora_bookmark_object_markup($fedora_object, $object_url_info) {
+function hook_islandora_bookmark_object_markup(AbstractObject $fedora_object, $object_url_info) {
+}
+
+/**
+ * Hook to alter existing markup for displaying a Fedora object within a table.
+ *
+ * @param AbstractObject $fedora_object
+ * An AbstractObject representing a Fedora object.
+ *
+ * @param array $object_url_info
+ * An associative array contains information to build an anchor tag.
+ * - path: A string containing the path/
+ * - params: An array of paramaters to be passed.
+ * - markup: A string containing the label for the anchor tag.
+ *
+ * @return array
+ * Returns an array containing the markup for displaying the Fedora object.
+ */
+function hook_islandora_bookmark_object_markup_alter(AbstractObject $fedora_object, $object_url_info) {
}
/**
@@ -39,15 +69,27 @@ function hook_islandora_bookmark_object_markup($fedora_object, $object_url_info)
*
* Content model specific.
*
+ * @param AbstractObject $fedora_object
+ * An AbstractObject representing a Fedora object.
+ *
+ * @param array $object_url_info
+ * An associative array contains information to build an anchor tag.
+ * - path: A string containing the path/
+ * - params: An array of paramaters to be passed.
+ * - markup: A string containing the label for the anchor tag.
+ *
* @return array
* Returns an array containing the markup for displaying the Fedora object.
*/
-function hook_CMODEL_PID_islandora_bookmark_object_markup($fedora_object, $object_url_info) {
+function hook_cmodel_pid_islandora_bookmark_object_markup(AbstractObject $fedora_object, $object_url_info) {
}
/**
* Hook to collect additional style options used in exporting.
*
+ * @param string $option
+ * The currently selected option we are trying to get additional styles for.
+ *
* @return array
* Returns an array containing the additional styles for export.
*/
@@ -60,7 +102,7 @@ function hook_islandora_bookmark_export_styles($option) {
* Sometimes you might want to alter fields for an rss item.
*
* @param AbstractObject $object
- * The bookmarked object
+ * An AbstractObject representing a Fedora object.
*
* @return array
* Returns an array containing the additional changes to the rss item.
@@ -71,7 +113,7 @@ function hook_islandora_bookmark_rss_item(AbstractObject $object) {
// for a valid bookmark RSS item.
$rss_item = array();
// The title of the item.
- $rss_item['title'] = 'Altered Title';;
+ $rss_item['title'] = 'Altered Title';
// The link of the item.
$rss_item['link'] = 'Altered Link';
// The description of the item.
@@ -105,3 +147,17 @@ function hook_islandora_bookmark_database_types() {
'my_type' => 'my_awesome_bookmark_class',
);
}
+
+/**
+ * Allows modules to modify values on creation of database lists.
+ *
+ * @param string $name
+ * The name for the list.
+ * @param string $type
+ * A string indicating the type of list. Default is 'bookmark'.
+ * @param object $owner
+ * A user object from which we can grab the uid.
+ */
+function hook_islandora_bookmark_create_new_database_list_alter(&$name, &$type, &$owner) {
+
+}
diff --git a/islandora_bookmark.info b/islandora_bookmark.info
index 4cffb24..1ec382e 100644
--- a/islandora_bookmark.info
+++ b/islandora_bookmark.info
@@ -1,12 +1,14 @@
name = Islandora Bookmark
description = Allows users to build, manage and track lists of PIDs.
dependencies[] = islandora
-package = Islandora
-configure = admin/islandora/islandora-bookmark
+package = Islandora Tools
+configure = admin/islandora/tools/islandora-bookmark
version = 7.x-dev
core = 7.x
files[] = includes/bookmark.inc
files[] = includes/bookmark_db.inc
+files[] = includes/bookmark_default_db.inc
+files[] = includes/bookmark_default_session.inc
files[] = includes/bookmark_session.inc
files[] = includes/solr_results.inc
stylesheets[all][] = css/islandora_bookmark.css
diff --git a/islandora_bookmark.install b/islandora_bookmark.install
index 0238045..e552705 100644
--- a/islandora_bookmark.install
+++ b/islandora_bookmark.install
@@ -60,6 +60,12 @@ function islandora_bookmark_schema() {
'length' => 255,
'not null' => TRUE,
),
+ 'descrip' => array(
+ 'description' => 'The supplied description of the list',
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'default' => '',
+ ),
'listowner' => array(
'description' => 'The user ID of who owns the list.',
'type' => 'int',
@@ -89,3 +95,31 @@ function islandora_bookmark_update_7100(&$sandbox) {
'default' => 'bookmark',
));
}
+
+/**
+ * Adds a description field to bookmarks.
+ */
+function islandora_bookmark_update_7101(&$sandbox) {
+ db_add_field('islandora_bookmark_list_names', 'descrip', array(
+ 'description' => 'The supplied description of the list',
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'default' => '',
+ ));
+}
+
+/**
+ * Implements hook_uninstall().
+ */
+function islandora_bookmark_uninstall() {
+ $variables = array(
+ 'islandora_bookmark_default_list_view',
+ 'islandora_bookmark_type',
+ 'islandora_bookmark_overview_page_elements',
+ 'islandora_bookmark_detailed_page_elements',
+ 'islandora_bookmark_create_user_default_lists',
+ 'islandora_bookmark_default_list_name',
+ 'islandora_bookmark_share_default_list',
+ );
+ array_walk($variables, 'variable_del');
+}
diff --git a/islandora_bookmark.module b/islandora_bookmark.module
index 8c385a2..2cca40f 100644
--- a/islandora_bookmark.module
+++ b/islandora_bookmark.module
@@ -1,10 +1,11 @@
0,
);
$items['islandora-bookmark/listid/%'] = array(
+ 'title callback' => 'islandora_bookmark_list_title',
+ 'title arguments' => array(2),
+ 'page callback' => 'islandora_bookmark_display_list',
+ 'page arguments' => array(2),
+ 'access callback' => 'islandora_bookmark_access',
+ 'access arguments' => array(2),
+ );
+ $items['islandora-bookmark/listid/%/manage'] = array(
'title callback' => 'islandora_bookmark_list_title',
'title arguments' => array(2),
'page callback' => 'islandora_bookmark_detailed_forms',
@@ -33,6 +42,15 @@ function islandora_bookmark_menu() {
'access callback' => 'islandora_bookmark_access',
'access arguments' => array(2),
);
+ $items['islandora-bookmark/listid/%/view'] = array(
+ 'title callback' => 'islandora_bookmark_list_title',
+ 'title arguments' => array(2),
+ 'page callback' => 'islandora_bookmark_view_bookmark',
+ 'page arguments' => array(2),
+ 'access callback' => 'islandora_bookmark_access',
+ 'access arguments' => array(2),
+ 'file' => 'theme/theme.inc',
+ );
$items['islandora-bookmark/listid/%/rss'] = array(
'title' => 'RSS Feed',
'type' => MENU_CALLBACK,
@@ -66,7 +84,7 @@ function islandora_bookmark_menu() {
'access arguments' => array(2),
'type' => MENU_CALLBACK,
);
- $items['admin/islandora/islandora-bookmark'] = array(
+ $items['admin/islandora/tools/islandora-bookmark'] = array(
'title' => 'Bookmark',
'description' => 'Configure settings for the Bookmark module.',
'page callback' => 'drupal_get_form',
@@ -74,7 +92,16 @@ function islandora_bookmark_menu() {
'access arguments' => array('administer islandora_bookmark'),
'file' => 'includes/admin.form.inc',
);
-
+ $items['admin/islandora/tools/islandora-bookmark/configure'] = array(
+ 'title' => 'Bookmark',
+ 'description' => 'Configure settings for the Bookmark module.',
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('islandora_bookmark_admin_settings'),
+ 'access arguments' => array('administer islandora_bookmark'),
+ 'file' => 'includes/admin.form.inc',
+ 'type' => MENU_DEFAULT_LOCAL_TASK,
+ 'weight' => 0,
+ );
return $items;
}
@@ -93,34 +120,10 @@ function islandora_bookmark_menu() {
function islandora_bookmark_access($list_id) {
global $user;
- preg_match('/session_/', $list_id, $match);
-
- if ($match) {
- $bookmark_access = TRUE;
- }
- else {
- $bookmark_access = FALSE;
-
- $owner_query = db_query('SELECT listowner FROM {islandora_bookmark_list_names} WHERE listid = :listid ORDER BY listid', array(':listid' => $list_id))->fetchObject();
-
- if ($owner_query && $owner_query->listowner === $user->uid) {
- $bookmark_access = TRUE;
- }
- else {
- $user_query = db_query('SELECT uid FROM {islandora_bookmark_list_users} WHERE listid = :listid', array(':listid' => $list_id));
- foreach ($user_query as $record) {
- if ($record->uid == $user->uid) {
- $bookmark_access = TRUE;
- break;
- }
- elseif ($record->uid == 0) {
- $bookmark_access = TRUE;
- break;
- }
- }
- }
- }
- return $bookmark_access;
+ $bookmark_object = Bookmark::getList($list_id);
+ // We explicitly check anonymous (uid 0) as bookmarks shared with that user
+ // are determined to be accessible to everyone.
+ return $bookmark_object && ($bookmark_object->bookmarkOwner === $user->uid || in_array($user->uid, $bookmark_object->getUsers()) || in_array('0', $bookmark_object->getUsers()));
}
/**
@@ -143,6 +146,11 @@ function islandora_bookmark_delete_bookmark_access($list_id) {
$bookmark_access = TRUE;
}
else {
+ module_load_include('inc', 'islandora_bookmark', 'includes/api');
+ $default_list = islandora_bookmark_get_default_list();
+ if ($default_list == $list_id) {
+ return FALSE;
+ }
$bookmark_access = FALSE;
$owner_query = db_query('SELECT listowner FROM {islandora_bookmark_list_names} WHERE listid = :listid ORDER BY listid', array(':listid' => $list_id))->fetchObject();
@@ -164,6 +172,10 @@ function islandora_bookmark_block_info() {
'info' => t('Islandora Bookmark'),
'cache' => DRUPAL_NO_CACHE,
);
+ $blocks['islandora_bookmark_list_info'] = array(
+ 'info' => t('Islandora Bookmark List Info'),
+ 'cache' => DRUPAL_NO_CACHE,
+ );
return $blocks;
}
@@ -195,6 +207,22 @@ function islandora_bookmark_block_view($delta = '') {
$block['pid'] = $pid;
}
break;
+
+ case 'islandora_bookmark_list_info':
+ // Block intended for use on the list view page.
+ // EX: 'islandora-bookmark/listid/1'.
+ if (arg(0) == 'islandora-bookmark') {
+ $list_id = arg(2);
+ if ($list_id) {
+ $bookmark = Bookmark::getList($list_id);
+ $block['content'] = array(
+ '#theme' => 'islandora_bookmark_list_info',
+ '#bookmark' => $bookmark,
+ );
+ }
+ }
+ break;
+
}
return $block;
}
@@ -232,6 +260,25 @@ function islandora_bookmark_theme() {
'template' => 'theme/islandora-bookmark-object-display',
'variables' => array('object_url_info' => NULL),
),
+ 'islandora_bookmark_list_columns' => array(
+ 'template' => 'theme/islandora-bookmark-list-columns',
+ 'variables' => array('bookmark_id' => NULL),
+ 'file' => 'theme/theme.inc',
+ ),
+ 'islandora_bookmark_list_links' => array(
+ 'variables' => array('bookmark_id' => NULL, 'current' => NULL),
+ 'file' => 'theme/theme.inc',
+ ),
+ 'islandora_bookmark_list_info' => array(
+ 'variables' => array(
+ 'bookmark' => NULL,
+ 'name' => '',
+ 'user' => '',
+ 'description' => '',
+ 'link' => '',
+ ),
+ 'template' => 'theme/islandora-bookmark-list-info',
+ ),
);
}
@@ -243,13 +290,60 @@ function islandora_bookmark_theme() {
* database.
*/
function islandora_bookmark_user_login(&$edit, $account) {
+ if (isset($_GET['destination'])) {
+ $destination = $_GET['destination'];
+
+ if (strpos($destination, 'islandora-bookmark/listid') === 0) {
+ $potential_list = substr($destination, strrpos($destination, '/') + 1, strlen($destination));
+ }
+ }
if (!empty($_SESSION['islandora_bookmark'])) {
foreach ($_SESSION['islandora_bookmark'] as $bookmark_session) {
- $persistent_bookmark = BookmarkDatabase::createNewList($bookmark_session->bookmarkName, 'bookmark', $account);
+ // If the list is deletable we can proceed as normal as it's not a
+ // default list.
+ if ($bookmark_session->getIsDeletable()) {
+ $persistent_bookmark = BookmarkDatabase::createNewList($bookmark_session->bookmarkName, 'bookmark', $account);
+ }
+ else {
+ module_load_include('inc', 'islandora_bookmark', 'includes/api');
+ $default_list = islandora_bookmark_get_default_list($account);
+ // A BookmarkDatabaseDefaultList already exists for this user, we will
+ // attempt to append on the PIDs.
+ if ($default_list) {
+ $persistent_bookmark = Bookmark::getList($default_list);
+ }
+ else {
+ $default_list_name = variable_get('islandora_bookmark_default_list_name', "@username's Default List");
+ $default_list_name = format_string($default_list_name, array('@username' => $account->name));
+ $persistent_bookmark = BookmarkDefaultDatabaseList::createNewList($default_list_name, 'bookmark_default', $account);
+ if (variable_get('islandora_bookmark_share_default_list', FALSE)) {
+ // The anonymous user (uid 0) is considered to be "Everyone".
+ $persistent_bookmark->addUser('0');
+ }
+ }
+ }
$persistent_bookmark->addPids($bookmark_session->getPids());
+ if (isset($potential_list) && $bookmark_session->getId() == $potential_list) {
+ $_GET['destination'] = "islandora-bookmark/listid/{$persistent_bookmark->getId()}";
+ }
}
unset($_SESSION['islandora_bookmark']);
}
+ if (variable_get('islandora_bookmark_create_user_default_lists', FALSE)) {
+ // Check if the user already has a default list made. If not create them
+ // one.
+ module_load_include('inc', 'islandora_bookmark', 'includes/api');
+ $default_list_exists = islandora_bookmark_get_default_list();
+ if (!$default_list_exists) {
+ $default_list_name = variable_get('islandora_bookmark_default_list_name', "@username's Default List");
+ $default_list_name = format_string($default_list_name, array('@username' => $account->name));
+ $created_default_list = BookmarkDefaultDatabaseList::createNewList($default_list_name, 'bookmark_default', $account);
+ if (variable_get('islandora_bookmark_share_default_list', FALSE)) {
+ // The anonymous user (uid 0) is considered to be "Everyone".
+ $created_default_list->addUser('0');
+ }
+ }
+ }
}
/**
@@ -266,6 +360,8 @@ function islandora_bookmark_delete_bookmark(array $form, array &$form_state) {
* The Drupal form definition.
* @param array $form_state
* The Drupal form state.
+ * @param string $list_id
+ * The list id of the Bookmark object we are going to delete.
*
* @return array
* The Drupal form definition.
@@ -318,6 +414,8 @@ function islandora_bookmark_remove_self(array $form, array &$form_state) {
* The Drupal form definition.
* @param array $form_state
* The Drupal form state.
+ * @param string $list_id
+ * The list id of the Bookmark object we are removing from.
*
* @return array
* The Drupal form definition.
@@ -337,7 +435,7 @@ function islandora_bookmark_remove_self_confirm(array $form, array &$form_state,
/**
* Submit handler for removing self from a Bookmark.
*
- * @global type $user
+ * @global stdClass $user
*
* @param array $form
* The Drupal form definition.
@@ -373,8 +471,9 @@ function islandora_bookmark_update_bookmark(array $form, array &$form_state) {
$bookmark_object = $form_state['bookmark_object'];
$newlist_name = $form_state['input']['bookmarks']['management']['listname'];
-
+ $newlist_description = $form_state['input']['bookmarks']['management']['description'];
$bookmark_object->changeListName(trim($newlist_name));
+ $bookmark_object->changeDescription(trim($newlist_description));
drupal_set_message(t('List settings updated.'));
}
@@ -385,6 +484,11 @@ function islandora_bookmark_update_bookmark(array $form, array &$form_state) {
*
* @param string $pid
* The PID of the object to create markup for.
+ * @param array $object_url_info
+ * An associative array contains information to build an anchor tag.
+ * - path: A string containing the path/
+ * - params: An array of paramaters to be passed.
+ * - markup: A string containing the label for the anchor tag.
*
* @return string
* The markup for the Fedora object in the table.
@@ -399,7 +503,7 @@ function islandora_bookmark_generate_markup($pid, $object_url_info = NULL) {
$object_url_info = array(
'path' => "islandora/object/$pid",
'params' => array(),
- 'markup' => $fedora_object->label ? $fedora_object->label : $fedora_object->pid,
+ 'markup' => $fedora_object->label ? $fedora_object->label : $fedora_object->id,
);
}
// Accumulate the output.
@@ -412,7 +516,7 @@ function islandora_bookmark_generate_markup($pid, $object_url_info = NULL) {
$output = array_merge_recursive($output, $temp);
}
}
-
+ drupal_alter('islandora_bookmark_object_markup', $fedora_object, $output);
// Add in the default, if we did not get any results.
if (empty($output)) {
$output = islandora_bookmark_object_display($object_url_info);
@@ -458,17 +562,28 @@ function islandora_bookmark_object_display($object_url_info) {
*
* @param string $list_id
* ID of the bookmark list to be rendered.
- *
- * @return string
- * Rendered forms to display and manage the bookmark list.
*/
function islandora_bookmark_detailed_forms($list_id) {
- $output = '';
- $detailed_form = drupal_get_form('islandora_bookmark_detailed_form', $list_id);
- $output .= drupal_render($detailed_form);
- $detailed_form_manage = drupal_get_form('islandora_bookmark_detailed_form_manage', $list_id);
- $output .= drupal_render($detailed_form_manage);
- return $output;
+ return array(
+ 'detailed_form' => drupal_get_form('islandora_bookmark_detailed_form', $list_id),
+ 'manage' => drupal_get_form('islandora_bookmark_detailed_form_manage', $list_id),
+ );
+}
+
+/**
+ * Menu callback for backwards compatibility and configuration of list display.
+ *
+ * @param string $list_id
+ * ID of the bookmark list to be rendered.
+ */
+function islandora_bookmark_display_list($list_id) {
+ $display = variable_get('islandora_bookmark_default_list_view', 'manage');
+ if ($display == 'manage') {
+ return islandora_bookmark_detailed_forms($list_id);
+ }
+ else {
+ return theme($display, array('bookmark_id' => $list_id));
+ }
}
/**
@@ -563,19 +678,23 @@ function islandora_bookmark_detailed_form_manage(array $form, array &$form_state
'#size' => 30,
'#default_value' => $bookmark->bookmarkName,
);
-
+ $form['bookmarks']['management']['description'] = array(
+ '#type' => 'textarea',
+ '#title' => t('Description'),
+ '#default_value' => $bookmark->bookmarkDescription,
+ );
$form['bookmarks']['management']['update'] = array(
'#type' => 'submit',
'#value' => t('Save'),
'#submit' => array('islandora_bookmark_update_bookmark'),
);
-
- $form['bookmarks']['management']['remove'] = array(
- '#type' => 'submit',
- '#value' => t('Delete list'),
- '#submit' => array('islandora_bookmark_delete_bookmark'),
- );
-
+ if ($bookmark->getIsDeletable()) {
+ $form['bookmarks']['management']['remove'] = array(
+ '#type' => 'submit',
+ '#value' => t('Delete list'),
+ '#submit' => array('islandora_bookmark_delete_bookmark'),
+ );
+ }
$form['bookmarks']['management']['list-id'] = array(
'#type' => 'value',
'#value' => $bookmark->getId(),
@@ -590,6 +709,9 @@ function islandora_bookmark_detailed_form_manage(array $form, array &$form_state
*
* @param string $pid
* PID to pass to the form. PID is gathered from url.
+ *
+ * @return string|NULL
+ * The markup of the object form or NULL otherwise.
*/
function islandora_bookmark_get_object_form($pid = NULL) {
$object_form = drupal_get_form('islandora_bookmark_fedora_repository_object_form', $pid);
@@ -607,12 +729,12 @@ function islandora_bookmark_get_object_form($pid = NULL) {
*
* Also, gives the ability to add the object to a Bookmark.
*
- * @global type $user
- *
* @param array $form
* The Drupal form definition.
* @param array $form_state
* The Drupal form state.
+ * @param string $pid
+ * The pid of the object which we are currently viewing.
*
* @return array
* The Drupal form definition.
@@ -642,19 +764,9 @@ function islandora_bookmark_fedora_repository_object_form(array $form, array &$f
);
}
- if (!isset($_SESSION['islandora_bookmark'])) {
- $owned_results = db_query('SELECT listname, listid from {islandora_bookmark_list_names} WHERE listowner = :listowner', array(':listowner' => $user->uid));
- $owned_lists = array();
- foreach ($owned_results as $record) {
- $owned_lists[$record->listid] = $record->listname;
- }
- }
- else {
- $owned_lists = array();
- foreach ($_SESSION['islandora_bookmark'] as $value) {
- $temp_list = $value;
- $owned_lists[$temp_list->getId()] = $temp_list->bookmarkName;
- }
+ $lists = islandora_bookmark_get_user_owned_bookmarks();
+ foreach ($lists as $list) {
+ $owned_lists[$list->getId()] = $list->bookmarkName;
}
if (count($owned_lists)) {
@@ -667,7 +779,7 @@ function islandora_bookmark_fedora_repository_object_form(array $form, array &$f
if (user_access('use islandora_bookmark')) {
if (!count($containing_lists)) {
$form['islandora_bookmark']['title'] = array(
- '#markup' => '
',
);
}
$form['islandora_bookmark']['add_bookmarks'] = array(
@@ -676,7 +788,7 @@ function islandora_bookmark_fedora_repository_object_form(array $form, array &$f
);
$form['islandora_bookmark']['add_button'] = array(
'#type' => 'submit',
- '#value' => t('Add @type', array('@type' => variable_get('islandora_bookmark_type', 'bookmark'))),
+ '#value' => t('Add to @type', array('@type' => variable_get('islandora_bookmark_type', 'bookmark'))),
'#ajax' => array(
'event' => 'click',
'callback' => 'islandora_bookmark_add_pid',
@@ -768,7 +880,7 @@ function islandora_bookmark_export_pids_as_csv($pids) {
/**
* Form constructor for the Bookmark overview form.
*
- * @global type $user
+ * @global stdClass $user
*
* @param array $form
* The Drupal form definition.
@@ -840,7 +952,6 @@ function islandora_bookmark_overview_form(array $form, array &$form_state) {
$offset_shared = $shared_page * $num_eles;
$shared_bookmarks = islandora_bookmark_get_user_shared_bookmarks();
$paged_shared_bookmarks = array_slice($shared_bookmarks, $offset_shared, $num_eles);
-
pager_default_initialize(count($shared_bookmarks), $num_eles, $element = 1);
$form['shared_bookmarks'] = array(
'fieldset' => array(
@@ -873,6 +984,7 @@ function islandora_bookmark_form_overview_table(array $bookmark_objs) {
$headers = array(
'bookmark_name' => t('List name'),
'bookmark_owner' => t('Owner'),
+ 'bookmark_desc' => t('Description'),
);
$rows = array();
foreach ($bookmark_objs as $bookmark) {
@@ -888,6 +1000,7 @@ function islandora_bookmark_form_overview_table(array $bookmark_objs) {
$rows[$id] = array(
'bookmark_name' => l($bookmark->bookmarkName, "islandora-bookmark/listid/$id"),
'bookmark_owner' => $owner_output,
+ 'bookmark_desc' => $bookmark->bookmarkDescription,
);
}
@@ -902,7 +1015,7 @@ function islandora_bookmark_form_overview_table(array $bookmark_objs) {
/**
* Form constructor for the add Bookmark form.
*
- * @global type $user
+ * @global stdClass $user
*
* @param array $form
* The Drupal form definition.
@@ -924,6 +1037,14 @@ function islandora_bookmark_add_form(array $form, array &$form_state) {
'#size' => 30,
);
+ $form['listdesc'] = array(
+ '#title' => t('List description'),
+ '#required' => FALSE,
+ '#description' => t('Descriptive text for the @type list.', array('@type' => variable_get('islandora_bookmark_type', 'bookmark'))),
+ '#type' => 'textfield',
+ '#size' => 30,
+ );
+
$form['submit'] = array(
'#type' => 'submit',
'#name' => 'islandora_bookmark_add_form_submit',
@@ -936,7 +1057,7 @@ function islandora_bookmark_add_form(array $form, array &$form_state) {
/**
* Form submission handler for the islandora_bookmark_add_form().
*
- * @global type $user
+ * @global stdClass $user
*
* @param array $form
* The Drupal form definition.
@@ -947,8 +1068,8 @@ function islandora_bookmark_add_form_submit(array $form, array &$form_state) {
global $user;
$bookmark_name = $form_state['values']['listname'];
-
- $temp_list = Bookmark::createNewList($bookmark_name);
+ $bookmark_description = $form_state['values']['listdesc'];
+ $temp_list = Bookmark::createNewList($bookmark_name, $bookmark_description);
$saved_list = NULL;
if ($user->uid == 0) {
$saved_list = 'Log into an account to save ' . variable_get('islandora_bookmark_type', 'bookmark') . ' lists; lists created anonymously will not be saved.';
@@ -1066,9 +1187,7 @@ function islandora_bookmark_list_title($list_id) {
module_load_include('inc', 'islandora_bookmark', 'includes/api');
$bookmark = islandora_bookmark_get_bookmark_by_number($list_id);
- check_plain($bookmark->bookmarkName);
-
- return check_plain($bookmark->bookmarkName);
+ return filter_xss($bookmark->bookmarkName);
}
/**
@@ -1086,5 +1205,6 @@ function islandora_bookmark_islandora_object_purged($pid) {
function islandora_bookmark_islandora_bookmark_database_types() {
return array(
'bookmark' => 'BookmarkDatabase',
+ 'bookmark_default' => 'BookmarkDefaultDatabaseList',
);
}
diff --git a/modules/islandora_bookmark_csv_exports/LICENSE.txt b/modules/islandora_bookmark_csv_exports/LICENSE.txt
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/LICENSE.txt
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/modules/islandora_bookmark_csv_exports/README.md b/modules/islandora_bookmark_csv_exports/README.md
new file mode 100644
index 0000000..ba6b653
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/README.md
@@ -0,0 +1,38 @@
+# Islandora Bookmark CSV Exports
+
+## Introduction
+
+The Islandora Bookmark CSV Exports allows users to create sets of Solr fields to be used to populate CSVs for exporting Bookmarks.
+
+# Requirements
+
+This module requires the following modules/libraries:
+
+* [Islandora](https://github.com/islandora/islandora)
+* [Tuque](https://github.com/islandora/tuque)
+* [Islandora Solr](https://github.com/islandora/islandora_solr_search)
+* [Islandora Bookmark](https://github.com/islandora/islandora_bookmark)
+
+
+## Installation
+
+Install as usual, see [this](https://drupal.org/documentation/install/modules-themes/modules-7) for further information.
+
+## Configuration
+
+Create configurations in Administration » Islandora » Islandora Utility Modules » Bookmark » CSV Exports (admin/islandora/tools/islandora-bookmark/csv_exports).
+
+## Troubleshooting/Issues
+
+Having problems or solved a problem? Check out the Islandora google groups for a solution.
+
+* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)
+* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)
+
+## Development
+
+If you would like to contribute to this module, please check out our helpful [Documentation for Developers](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers) info, as well as our [Developers](http://islandora.ca/developers) section on the Islandora.ca site.
+
+## License
+
+[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt)
diff --git a/modules/islandora_bookmark_csv_exports/includes/config.form.inc b/modules/islandora_bookmark_csv_exports/includes/config.form.inc
new file mode 100644
index 0000000..205f738
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/includes/config.form.inc
@@ -0,0 +1,159 @@
+ 'fieldset',
+ '#title' => t('Configuration'),
+ '#collapsed' => TRUE,
+ '#collapsible' => FALSE,
+ );
+ $default_delimiter = !empty($db_values['delimiter']) ? $db_values['delimiter'] : '\n';
+ $form['configuration']['delimiter'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Multi-valued delimiter'),
+ '#required' => TRUE,
+ '#description' => t('This will be the delimiter value used as a glue in between multi valued fields pulled from Solr. Defaults to "\n"'),
+ '#default_value' => $default_delimiter,
+ );
+ $form['configuration']['description'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Description'),
+ '#description' => t('A description used to describe the CSV export, used in the UI.'),
+ '#default_value' => $db_values['descrip'],
+ '#required' => TRUE,
+ );
+ $form['configuration']['fields'] = array(
+ '#type' => 'textarea',
+ '#title' => t('Fields to be exported'),
+ '#description' => t('The order in which the fields appear separated by spaces or commas will dictate the write order in the CSV.'),
+ '#value' => $fields,
+ '#prefix' => '
',
+ '#suffix' => '
',
+ '#required' => TRUE,
+ );
+ $form['configuration']['solr_autocomplete'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Solr field'),
+ '#description' => t('This will be used to pull content when generating the CSV for export.'),
+ '#size' => 105,
+ '#autocomplete_path' => 'islandora_solr/autocomplete_luke',
+ '#default_value' => '',
+ );
+ $form['configuration']['solr_add'] = array(
+ '#type' => 'button',
+ '#value' => t('Add'),
+ '#ajax' => array(
+ 'callback' => 'islandora_bookmark_csv_exports_solr_ajax',
+ 'wrapper' => 'islandora-bookmark-csv-exports-solr-wrapper',
+ ),
+ '#name' => 'islandora-bookmark-csv-exports-solr-add',
+ );
+ $form['configuration_id'] = array(
+ '#type' => 'value',
+ '#value' => $configuration_id,
+ );
+ $form['save'] = array(
+ '#type' => 'submit',
+ '#value' => t('Save'),
+ );
+ $form['delete'] = array(
+ '#type' => 'submit',
+ '#value' => t('Delete'),
+ '#submit' => array('islandora_bookmark_csv_exports_config_form_submit'),
+ '#limit_validation_errors' => array(array('configuration_id')),
+ );
+ return $form;
+}
+
+/**
+ * Validation for the configuration form.
+ */
+function islandora_bookmark_csv_exports_config_form_validate($form, $form_state) {
+ module_load_include('inc', 'islandora_csv_exports', 'includes/db');
+ if ($form_state['triggering_element']['#parents'] == array('save')) {
+ // See if the description is unique.
+ if (!empty($form_state['values']['description'])) {
+ if (islandora_bookmark_csv_exports_description_exists($form_state['values']['description'], $form_state['values']['configuration_id'])) {
+ form_error($form['configuration']['description'], t('A configuration with the description of @description already exists.', array('@description' => $form_state['values']['description'])));
+ }
+ }
+ if (empty($form_state['input']['fields'])) {
+ form_error($form['configuration']['fields'], t('Fields field is required.'));
+ }
+ }
+}
+
+/**
+ * Submit handler for the configuration form.
+ *
+ * @param array $form
+ * An array representing a form within Drupal.
+ * @param array $form_state
+ * An array containing the Drupal form state.
+ */
+function islandora_bookmark_csv_exports_config_form_submit($form, &$form_state) {
+ module_load_include('inc', 'islandora_csv_exports', 'includes/db');
+ if ($form_state['triggering_element']['#parents'] == array('save')) {
+ // Munge the textarea into a form we can expect.
+ $fields = array_filter(preg_split('/[,\s]/', $form_state['input']['fields']));
+ islandora_bookmark_csv_exports_add_values($form_state['values']['configuration_id'], array(
+ 'description' => $form_state['values']['description'],
+ 'fields' => serialize($fields),
+ 'delimiter' => $form_state['values']['delimiter'],
+ ));
+ drupal_set_message(t('Configuration saved.'));
+ }
+ else {
+ islandora_bookmark_csv_exports_delete_configuration($form_state['values']['configuration_id']);
+ drupal_set_message(t('Configuration deleted.'));
+ $form_state['redirect'] = 'admin/islandora/tools/islandora-bookmark/csv_exports';
+ }
+}
+
+/**
+ * AJAX callback for Solr field adding.
+ *
+ * @param array $form
+ * An array representing a form within Drupal.
+ * @param array $form_state
+ * An array containing the Drupal form state.
+ *
+ * @return array
+ * The portion of the form to be rendered.
+ */
+function islandora_bookmark_csv_exports_solr_ajax(&$form, &$form_state) {
+ return $form['configuration']['fields'];
+}
diff --git a/modules/islandora_bookmark_csv_exports/includes/db.inc b/modules/islandora_bookmark_csv_exports/includes/db.inc
new file mode 100644
index 0000000..ae2a5cc
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/includes/db.inc
@@ -0,0 +1,185 @@
+configuration_name;
+ $configurations[] = array(
+ 'name' => $config_name,
+ 'id' => $record->configuration_id,
+ 'machine_name' => $record->machine_name,
+ 'descrip' => $record->descrip,
+ 'fields' => $record->config_fields,
+ );
+ }
+ return $configurations;
+}
+
+/**
+ * Gets configuration by ID.
+ *
+ * @param string $configuration_id
+ * The configuration ID of the export to get.
+ *
+ * @return array
+ * An array describing the configuration.
+ */
+function islandora_bookmark_csv_exports_get_configuration_by_id($configuration_id) {
+ return db_select('islandora_bookmark_csv_exports', 'i')
+ ->fields('i', array())
+ ->condition('i.configuration_id', $configuration_id)
+ ->execute()
+ ->fetchAssoc();
+}
+
+/**
+ * Get the ID for the given configuration.
+ *
+ * @param string $machine_name
+ * The machine name of the configuration ID we are grabbing.
+ *
+ * @return bool|int
+ * The configuration ID if it exists; otherwise, FALSE.
+ */
+function islandora_bookmark_csv_exports_get_configuration_from_machine_name($machine_name) {
+ $result = db_query('SELECT configuration_id from {islandora_bookmark_csv_exports} WHERE machine_name = :machine_name', array(':machine_name' => $machine_name));
+ $config_id = $result->fetchColumn();
+ return $config_id;
+}
+
+/**
+ * Create a new configuration.
+ *
+ * @param string $configuration_name
+ * The name of a configuration to add the the DB.
+ * @param string $machine_name
+ * The unique machine name to add the the DB.
+ *
+ * @return int
+ * The ID with which the configuration was created in the database.
+ */
+function islandora_bookmark_csv_exports_add_configuration($configuration_name, $machine_name) {
+ $id = db_insert('islandora_bookmark_csv_exports')
+ ->fields(
+ array(
+ 'configuration_name' => $configuration_name,
+ 'machine_name' => $machine_name,
+ )
+ )
+ ->execute();
+ return $id;
+}
+
+/**
+ * Get fields associated with the given configuration.
+ *
+ * @param int $configuration_id
+ * The ID of the configuration for which to grab the fields.
+ *
+ * @return array
+ * An array containing the unserialized fields for the config.
+ */
+function islandora_bookmark_csv_exports_get_values($configuration_id) {
+ $result = db_query('SELECT descrip, config_fields FROM {islandora_bookmark_csv_exports} WHERE configuration_id = :configuration_id', array(':configuration_id' => $configuration_id));
+ $values = $result->fetchAssoc();
+ $values['config_fields'] = unserialize($values['config_fields']);
+ return $values;
+}
+
+/**
+ * Check that a configuration exists with the given ID.
+ *
+ * @param int $configuration_id
+ * An ID to test.
+ *
+ * @return bool
+ * Whether or not the ID exists.
+ */
+function islandora_bookmark_csv_exports_configuration_exists($configuration_id) {
+ $result = db_query('SELECT COUNT(*) FROM {islandora_bookmark_csv_exports} WHERE configuration_id = :configuration_id', array(':configuration_id' => $configuration_id));
+ return intval($result->fetchField()) > 0;
+}
+
+/**
+ * Get the name for the given configuration.
+ *
+ * @param int $configuration_id
+ * The ID for a configuration for which to grab the name.
+ *
+ * @return string
+ * The name of the configuration.
+ */
+function islandora_bookmark_csv_exports_retrieve_configuration_name($configuration_id) {
+ $result = db_query('SELECT configuration_name from {islandora_bookmark_csv_exports} WHERE configuration_id = :configuration_id', array(':configuration_id' => $configuration_id));
+ $config_name = $result->fetchColumn();
+ return $config_name;
+}
+
+/**
+ * Add things to the database.
+ *
+ * @param int $configuration_id
+ * The configuration ID of the configuration which to add to.
+ * @param array $values
+ * An associative array containing values of things:
+ * - fields: A serialize array of Solr fields.
+ * - description: A string describing the configuration.
+ * - delimiter: A string used as glue for multi valued Solr fields.
+ */
+function islandora_bookmark_csv_exports_add_values($configuration_id, $values) {
+ db_update('islandora_bookmark_csv_exports')
+ ->fields(array(
+ 'config_fields' => $values['fields'],
+ 'descrip' => $values['description'],
+ 'delimiter' => $values['delimiter'],
+ ))
+ ->condition('configuration_id', $configuration_id)
+ ->execute();
+}
+
+/**
+ * Delete the given configuration indicated by the given ID.
+ *
+ * @param int $configuration_id
+ * The ID for a configuration to remove.
+ */
+function islandora_bookmark_csv_exports_delete_configuration($configuration_id) {
+ db_delete('islandora_bookmark_csv_exports')
+ ->condition('configuration_id', $configuration_id)
+ ->execute();
+}
+
+/**
+ * Sees if the description exists on a configuration.
+ *
+ * @param string $description
+ * The description to check.
+ * @param string $configuration_id
+ * The configuration ID of the configuration being checked.
+ *
+ * @return bool
+ * Whether or not the description is unique.
+ */
+function islandora_bookmark_csv_exports_description_exists($description, $configuration_id) {
+ return intval(db_select('islandora_bookmark_csv_exports', 'i')
+ ->condition('configuration_id', $configuration_id, '!=')
+ ->condition('descrip', $description)
+ ->fields('i', array('configuration_id'))
+ ->execute()
+ ->fetchCol());
+}
diff --git a/modules/islandora_bookmark_csv_exports/includes/export.inc b/modules/islandora_bookmark_csv_exports/includes/export.inc
new file mode 100644
index 0000000..de82f19
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/includes/export.inc
@@ -0,0 +1,90 @@
+configurationId = $config_id;
+ }
+
+ /**
+ * Exports as a CSV.
+ *
+ * @param array $pids
+ * An array of pids to be exported.
+ * @param bool|string $style
+ * The style/value of the dependent dropdown from Bookmark.
+ */
+ public function export($pids, $style = FALSE) {
+ // @TODO: Batch this?
+ if ($style) {
+ $this->style = $style;
+ }
+ module_load_include('inc', 'islandora_bookmark_csv_exports', 'includes/db');
+ $config = islandora_bookmark_csv_exports_get_configuration_by_id($this->configurationId);
+ $solr_fields = drupal_map_assoc(unserialize($config['config_fields']));
+
+ if (!empty($solr_fields)) {
+ $headers = array();
+ $csv_values = array();
+ $scrub_csv = function($value) use($config) {
+ if (!is_array($value)) {
+ $value = (array) $value;
+ }
+ // Trim off any extra values.
+ $value = array_filter(array_map('trim', $value));
+ $value = implode($config['delimiter'], $value);
+ return $value;
+ };
+ $added_pid = FALSE;
+ if (!isset($solr_fields['PID'])) {
+ $solr_fields['PID'] = 'PID';
+ $added_pid = TRUE;
+ }
+ foreach ($pids as $pid) {
+ $query_processor = new IslandoraSolrQueryProcessor();
+ $query_processor->solrQuery = 'PID:"' . $pid . '"';
+ // Solr needs the PID field to be here to avoid warnings.
+ $query_processor->solrParams['fl'] = implode(', ', $solr_fields);
+ $query_processor->executeQuery(FALSE);
+ if ($query_processor->islandoraSolrResult['response']['numFound'] > 0) {
+ $solr_results_doc = $query_processor->islandoraSolrResult['response']['objects']['0']['solr_doc'];
+ // If we added the PID to appease Solr remove it now.
+ if ($added_pid) {
+ unset($solr_results_doc['PID']);
+ }
+ $solr_results_doc = array_filter(array_map($scrub_csv, $solr_results_doc));
+ // Ensure we only provide results for what is specified.
+ $csv_line = array_intersect_key(drupal_map_assoc($headers), $solr_results_doc);
+ $diff = array_diff($solr_results_doc, drupal_map_assoc($headers));
+ $csv_line = array_merge($csv_line, $diff);
+ $headers = array_merge(drupal_map_assoc($headers), drupal_map_assoc(array_keys($diff)));
+ $csv_values[$pid] = $csv_line;
+ }
+ }
+ drupal_add_http_header('Content-Type', 'text/csv');
+ drupal_add_http_header('Content-Disposition', "attachment;filename=islandora_bookmark_csv_exports.csv");
+ $fp = fopen('php://output', 'w');
+ // Allow modules to alter before we write.
+ $this->headers = $headers;
+ $this->lines = $csv_values;
+ drupal_alter('islandora_bookmark_csv_exports_lines', $this);
+ fputcsv($fp, $this->headers);
+ foreach ($this->lines as $line) {
+ fputcsv($fp, $line);
+ }
+ fclose($fp);
+ drupal_exit();
+ }
+ }
+}
diff --git a/modules/islandora_bookmark_csv_exports/includes/overview.form.inc b/modules/islandora_bookmark_csv_exports/includes/overview.form.inc
new file mode 100644
index 0000000..5ec5cfc
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/includes/overview.form.inc
@@ -0,0 +1,101 @@
+ t('CSV Export configurations'),
+ '#markup' => theme('table', array(
+ 'header' => array(
+ t('Name'),
+ t('Description'),
+ t('Machine name'),
+ ),
+ 'rows' => $rows,
+ 'empty' => t('No associations currently present.'),
+ )),
+ );
+ $form['add_configuration'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Add a configuration'),
+ '#collapsible' => FALSE,
+ '#collapsed' => FALSE,
+ );
+ $form['add_configuration']['configuration_name'] = array(
+ '#type' => 'textfield',
+ '#size' => 100,
+ '#title' => t('Configuration name'),
+ );
+ $form['add_configuration']['machine_name'] = array(
+ '#type' => 'textfield',
+ '#size' => 100,
+ '#title' => t('Machine name'),
+ '#description' => t('A unique machine name used in the exportation of features'),
+ );
+ $form['add_configuration']['save'] = array(
+ '#type' => 'submit',
+ '#value' => t('Add configuration'),
+ );
+ return $form;
+}
+
+/**
+ * Validation for the overview form.
+ *
+ * @param array $form
+ * An array representing a Drupal form.
+ * @param array $form_state
+ * An array containing the Drupal form state.
+ */
+function islandora_bookmark_csv_exports_overview_form_validate($form, $form_state) {
+ if (empty($form_state['values']['configuration_name'])) {
+ form_set_error('configuration_name', t('Please enter a non-empty configuration name!'));
+ }
+ if (empty($form_state['values']['machine_name'])) {
+ form_set_error('machine_name', t('Please enter a non-empty machine name!'));
+ }
+ else {
+ module_load_include('inc', 'islandora_bookmark_csv_exports', 'includes/db');
+ $config_exists = islandora_bookmark_csv_exports_get_configuration_from_machine_name($form_state['values']['machine_name']);
+ if ($config_exists !== FALSE) {
+ form_set_error('machine_name', t('The machine name of @machine already exists in the database!', array('@machine' => $form_state['values']['machine_name'])));
+ }
+ }
+}
+
+/**
+ * Submit handler for the overview form.
+ *
+ * @param array $form
+ * An array representing a Drupal form.
+ * @param array $form_state
+ * An array containing the Drupal form state.
+ */
+function islandora_bookmark_csv_exports_overview_form_submit($form, $form_state) {
+ module_load_include('inc', 'islandora_bookmark_csv_exports', 'includes/db');
+ islandora_bookmark_csv_exports_add_configuration($form_state['values']['configuration_name'], $form_state['values']['machine_name']);
+ drupal_set_message(t('A new empty configuration has been created for @config_name', array('@config_name' => $form_state['values']['configuration_name'])));
+}
diff --git a/modules/islandora_bookmark_csv_exports/islandora_bookmark_csv_exports.api.php b/modules/islandora_bookmark_csv_exports/islandora_bookmark_csv_exports.api.php
new file mode 100644
index 0000000..a5957d1
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/islandora_bookmark_csv_exports.api.php
@@ -0,0 +1,15 @@
+ 'Stores CSV configurations and their associated fields.',
+ 'fields' => array(
+ 'configuration_id' => array(
+ 'description' => 'The ID of the configuration',
+ 'type' => 'serial',
+ 'length' => 11,
+ 'not null' => TRUE,
+ ),
+ 'configuration_name' => array(
+ 'description' => 'The name of the configuration (used in the UI).',
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'not null' => TRUE,
+ ),
+ 'descrip' => array(
+ 'description' => 'The supplied description of the list (used in the UI).',
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'default' => '',
+ ),
+ 'delimiter' => array(
+ 'description' => 'The glue to piece together multi valued fields pulled from Solr.',
+ 'type' => 'varchar',
+ 'length' => 10,
+ ),
+ 'machine_name' => array(
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'description' => 'The machine readable name for this config.',
+ 'not null' => TRUE,
+ ),
+ 'config_fields' => array(
+ 'type' => 'blob',
+ 'not null' => FALSE,
+ 'size' => 'big',
+ 'serialize' => TRUE,
+ 'description' => 'A serialized array of name value pairs that store fields for export.',
+ ),
+ ),
+ 'primary key' => array('configuration_id'),
+ );
+ return $schema;
+}
diff --git a/modules/islandora_bookmark_csv_exports/islandora_bookmark_csv_exports.module b/modules/islandora_bookmark_csv_exports/islandora_bookmark_csv_exports.module
new file mode 100644
index 0000000..8c901d4
--- /dev/null
+++ b/modules/islandora_bookmark_csv_exports/islandora_bookmark_csv_exports.module
@@ -0,0 +1,92 @@
+ 'CSV Exports',
+ 'description' => 'Configure settings for the Bookmark CSV Exports module.',
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('islandora_bookmark_csv_exports_overview_form'),
+ 'access arguments' => array('administer islandora_bookmark_csv_exports'),
+ 'file' => 'includes/overview.form.inc',
+ 'type' => MENU_LOCAL_TASK,
+ 'weight' => 1,
+ );
+ $items['admin/islandora/tools/islandora-bookmark/csv_exports/config/%'] = array(
+ 'title callback' => 'islandora_bookmark_csv_exports_display_configuration_name',
+ 'title arguments' => array(6),
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('islandora_bookmark_csv_exports_config_form', 6),
+ 'access callback' => 'islandora_bookmark_csv_exports_access',
+ 'access arguments' => array(6),
+ 'file' => 'includes/config.form.inc',
+ );
+ return $items;
+}
+
+/**
+ * Implements hook_permission().
+ */
+function islandora_bookmark_csv_exports_permission() {
+ return array(
+ ISLANDORA_BOOKMARK_CSV_EXPORTS_PERMISSION => array(
+ 'title' => 'Create and manage Bookmark CSV exports configurations',
+ ),
+ );
+}
+
+/**
+ * Access callback for accessing a configuration based upon ID.
+ *
+ * @param int $configuration_id
+ * The configuration ID of the list we are accessing.
+ *
+ * @return bool
+ * TRUE if the user has permission and the config exists, FALSE otherwise.
+ */
+function islandora_bookmark_csv_exports_access($configuration_id) {
+ module_load_include('inc', 'islandora_bookmark_csv_exports', 'includes/db');
+ return islandora_bookmark_csv_exports_configuration_exists($configuration_id) && user_access(ISLANDORA_BOOKMARK_CSV_EXPORTS_PERMISSION);
+}
+
+/**
+ * Title callback for the configuration display.
+ *
+ * @param int $configuration_id
+ * The ID of the configuration we are retrieving the name of.
+ *
+ * @return string
+ * The name of the configuration that is to be edited.
+ */
+function islandora_bookmark_csv_exports_display_configuration_name($configuration_id) {
+ module_load_include('inc', 'islandora_bookmark_csv_exports', 'includes/db');
+ $configuration_name = islandora_bookmark_csv_exports_retrieve_configuration_name($configuration_id);
+ return format_string('@configuration_name export configuration', array('@configuration_name' => $configuration_name));
+}
+
+/**
+ * Implements hook_islandora_bookmark_export_handler().
+ */
+function islandora_bookmark_csv_exports_islandora_bookmark_export_handler() {
+ module_load_include('inc', 'islandora_bookmark_csv_exports', 'includes/db');
+ $configs = islandora_bookmark_csv_exports_get_configurations();
+ $handlers = array();
+ foreach ($configs as $config) {
+ if (!empty($config['descrip']) && $config['fields']) {
+ $handlers['Bookmark CSV'][$config['machine_name']] = array(
+ 'human_readable' => $config['descrip'],
+ 'callable' => array(new IslandoraBookmarkCSVExportsExport($config['id']), 'export'),
+ );
+ }
+ }
+ return $handlers;
+}
diff --git a/theme/islandora-bookmark-list-columns.tpl.php b/theme/islandora-bookmark-list-columns.tpl.php
new file mode 100644
index 0000000..6b89f6d
--- /dev/null
+++ b/theme/islandora-bookmark-list-columns.tpl.php
@@ -0,0 +1,28 @@
+
+