diff --git a/sites/all/modules/recently_read/LICENSE.txt b/sites/all/modules/recently_read/LICENSE.txt new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/sites/all/modules/recently_read/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. diff --git a/sites/all/modules/recently_read/README.txt b/sites/all/modules/recently_read/README.txt new file mode 100644 index 0000000..11ed2b7 --- /dev/null +++ b/sites/all/modules/recently_read/README.txt @@ -0,0 +1,93 @@ + +== SUMMARY == + +The Recently Read module displays the history of recently read content (nodes) +a particular user has viewed. Each authenticated user has its own history +recorded, so this module may be useful i.e. for displaying recently viewed +products on the e-commerce site. The history is displayed as a block and each +content type gets its own block. + +If you need more flexibility, this module can be replaced by properly configured +Flag, Rules and Views modules. Check out the following links for more details: +* http://drupal.org/node/405754 +* http://jan.tomka.name/blog/list-recently-viewed-nodes-drupal + +For a full description of the module, visit the project page: + http://drupal.org/sandbox/pgorecki/1080970 + +To submit bug reports and feature suggestions, or to track changes: + http://drupal.org/project/issues/1080970 + + +== REQUIREMENTS == + +None. + + +== INSTALLATION == + +* Install as usual, see http://drupal.org/node/70151 for further information. + + +== CONFIGURATION == + +* Customize the module settings in Administer >> Site configuration >> + Recently read content. On this pace you can: + + - Select which content types will should be tracked by the module + + After enabling content type tracking, go to Administer >> Site building >> + Blocks to configure the block settings of each tracked content type. + + - Recently read list length specifies the maximum number of nodes + per user per content type that will be stored in a databse. Note that this + is different from "Maximum number of links to display in the block" setting + available in the Recently read block configutation options. + +== CUSTOMIZATION == + +Recently read module lacks UI for advanced configuration, but most tasks can +be easily implemented by code snippets or in the theme layer. + +* Displaying more than a node title + + By default, Recently Read block displays a list of links to node titles. + You can customize the output by overriding theme_recently_read_item() and + theme_recently_read_item_list() functions in your theme. + + For example, to display an image field and a link: + + function mytemplate_recently_read_item($item) { + $output = ''; + if ($item['type'] == 'page') { + $node = node_load($item['nid']); + if (isset($node->field_image[0])) { + $output .= theme('imagefield_item', $node->field_image[0]); + } + } + $output .= l($item['title'], 'node/' . $item['nid']); + return $output; + } + +* Multiple content types in the same block + + To display multiple content types in the same block, create a new block with PHP body + and modify the following examlpe to your needs: + + uid : 0; + $items = recently_read_get_read_items(array('page', 'article'), $user_id, 3); + // get html string with all items + return theme('recently_read_item_list', array('items' => $items)); + ?> + + +-- CONTACT -- + +Current maintainer: +* Przemyslaw Gorecki (pgorecki) - http://drupal.org/user/642012 diff --git a/sites/all/modules/recently_read/recently_read.info b/sites/all/modules/recently_read/recently_read.info new file mode 100644 index 0000000..5b69061 --- /dev/null +++ b/sites/all/modules/recently_read/recently_read.info @@ -0,0 +1,11 @@ +name = Recently read +description = Tracks the history of recently read content by each user. +core = 6.x +package = Other + +; Information added by drupal.org packaging script on 2012-03-02 +version = "6.x-1.0-beta1" +core = "6.x" +project = "recently_read" +datestamp = "1330713350" + diff --git a/sites/all/modules/recently_read/recently_read.install b/sites/all/modules/recently_read/recently_read.install new file mode 100644 index 0000000..a8d80a3 --- /dev/null +++ b/sites/all/modules/recently_read/recently_read.install @@ -0,0 +1,67 @@ + 'Table for history of read nodes', + 'fields' => array( + 'nid' => array( + 'description' => 'The {node}.nid of the read node.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0 + ), + 'type' => array( + 'description' => 'The type of the read node.', + 'type' => 'varchar', + 'length' => 32, + 'not null' => TRUE, + 'default' => '' + ), + 'uid' => array( + 'description' => 'The {user}.uid that read the node.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0 + ), + 'timestamp' => array( + 'description' => 'The time the node has been read.', + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0 + ) + ), + 'primary key' => array('nid', 'uid') + ); + return $schema; +} + + +/** + * Implementation of hook_install(). + */ +function recently_read_install() { + drupal_install_schema('recently_read'); +} + + +/** + * Implementation of hook_uninstall(). + */ +function recently_read_uninstall() { + drupal_uninstall_schema('recently_read'); + variable_del('recently_read_node_types'); + variable_del('recently_read_max_entries'); + variable_del('recently_read_max_length'); +} diff --git a/sites/all/modules/recently_read/recently_read.module b/sites/all/modules/recently_read/recently_read.module new file mode 100644 index 0000000..71f1930 --- /dev/null +++ b/sites/all/modules/recently_read/recently_read.module @@ -0,0 +1,384 @@ + 'Recently read content', + 'description' => 'Tracks the history of recently read content by each user.', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('recently_read_settings'), + 'access arguments' => array('administer site configuration'), + 'type' => MENU_NORMAL_ITEM, + ); + return $items; +} + + +/** + * Implementation of hook_theme(). + */ +function recently_read_theme() { + return array( + 'recently_read_item' => array( + 'arguments' => array('item' => NULL) + ), + 'recently_read_item_list' => array( + 'arguments' => array('item' => NULL) + ), + ); +} + + +/** + * Implementation of hook_block(). + */ +function recently_read_block($op = 'list', $delta = 0, $edit = array()) { + switch ($op) { + case 'list': + // each enabled content type has its own block + $types = node_get_types(); + $enabled = variable_get('recently_read_node_types', array('page', 'story')); + $blocks = array(); + foreach ($enabled as $key) { + $blocks[$key]['info'] = t('Recently read - @type', array('@type' => $types[$key]->name)); + $blocks[$key]['cache'] = BLOCK_NO_CACHE; + } + return $blocks; + + case 'configure': + // allow user to customize the length of a list for each node type + $max_entries = variable_get('recently_read_max_entries', 10); + $max_count = variable_get("recently_read_max_length", array('page' => 10, 'story' => 10)); + + $form['items_count'] = array( + '#type' => 'textfield', + '#title' => t('Maximum number of links to display in the block'), + '#description' => t('Enter the positive integer value, less or equal to %limit.', + array('%limit' => $max_entries) + ), + '#default_value' => (key_exists($delta, $max_count)) ? $max_count[$delta] : $max_entries, + ); + return $form; + + case 'save': + // save configuration settings + $max_entries = variable_get('recently_read_max_entries', 10); + $value = max(1, min($edit['items_count'], $max_entries)); + $max_count = variable_get('recently_read_max_length', array('page' => 10, 'story' => 10)); + $max_count[$delta] = $value; + variable_set('recently_read_max_length', $max_count); + return; + + case 'view': + // disable caching of entire page if recently read block is being displayed + recently_read_disable_page_cache(); + + // view block containing links to recently visited nodes + global $user; + + $max_entries = variable_get('recently_read_max_entries', 10); + $max_count = variable_get('recently_read_max_length', array('page' => 10, 'story' => 10)); + isset($max_count[$delta]) ? $limit = $max_count[$delta] : $limit = $max_entries; + + $items = recently_read_get_read_items(array($delta), $user->uid, $limit); + $types = node_get_types(); + return array( + 'subject' => t('Recently read - @type', array('@type' => $types[$delta]->name)), + 'content' => theme('recently_read_item_list', $items) + ); + } +} + + +function recently_read_exit() { + global $user; + + drupal_bootstrap(DRUPAL_BOOTSTRAP_PATH); + + // track history for authenticated user + if ((arg(0) == 'node') && is_numeric(arg(1)) && arg(2) == '') { + $nid = arg(1); + + // get node type + $type = db_result(db_query('SELECT type FROM {node} WHERE nid = %d', $nid)); + + // track history for authenticated user + if (recently_read_is_enabled($type) && $user->uid) { + $record = new stdClass(); + $record->nid = $nid; + $record->type = $type; + $record->uid = $user->uid; + $record->timestamp = time(); + + $count = db_result(db_query( + 'SELECT COUNT(*) FROM {recently_read_nodes} WHERE nid = %d AND uid = %d AND type = "%s"', + $nid, $user->uid, $type + )); + // a node has been viewed before, make an update + if ($count > 0) { + drupal_write_record('recently_read_nodes', $record, array('nid', 'uid')); + } + // a node has not been viewed before, add new row + else { + drupal_write_record('recently_read_nodes', $record); + } + } + + // track history for anonymous user + if (recently_read_is_enabled($type) && !$user->uid && variable_get('recently_read_anonymous_enabled', FALSE)) { + + $key = "recently_read-$type"; + if (!isset($_SESSION[$key])) { + $_SESSION[$key] = array(); + } + + // remove previous entry, if present + unset($_SESSION[$key][$nid]); + + // add new entry at the beginning of array + $title = db_result(db_query('SELECT title FROM {node} WHERE nid = %d', $nid)); + $entry = array( + 'nid' => $nid, + 'title' => $title, + 'type' => $type, + 'timestamp' => time() + ); + $_SESSION[$key] = array($nid => $entry) + $_SESSION[$key]; + + while (count($_SESSION[$key]) > variable_get('recently_read_max_entries', 10)) { + array_pop($_SESSION[$key]); + } + } + + // remove old entries + $nids = array(); + $result = db_query("SELECT nid FROM {recently_read_nodes} WHERE uid = %d and type = '%s' ORDER BY timestamp DESC LIMIT %d,1000", + $user->uid, + $type, + variable_get('recently_read_max_entries', 10)+1 + ); + while ($nid = db_result($result)) { + $nids[] = $nid; + }; + if (count($nids)) { + $placeholders = implode(',', array_fill(0, count($nids), "%d")); + db_query("DELETE FROM {recently_read_nodes} WHERE uid = %d AND nid IN($placeholders)", + array_merge((array) $user->uid, $nids) + ); + } + } +} + + +/* + * Form builder; Configure recently read settings. + */ +function recently_read_settings() { + $types = node_get_types(); + + $options = array(); + foreach ($types as $key => $type) { + $options[$key] = $type->name; + } + + $form['node_types'] = array( + '#type' => 'checkboxes', + '#title' => t('Enable history tracking of the following content'), + '#description' => t('Select which content types will be tracked.'), + '#default_value' => variable_get('recently_read_node_types', array('page', 'story')), + '#options' => $options + ); + + $form['anonymous_enabled'] = array( + '#type' => 'checkbox', + '#title' => t('Enable history tracking for anonymous users'), + '#description' => t('If disabled, user must be logged to view recently read blocks.'), + '#default_value' => variable_get('recently_read_anonymous_enabled', FALSE) + ); + + $form['max_entries'] = array( + '#type' => 'textfield', + '#title' => t('Recently read list length'), + '#description' => 'Provide the maximum number of entires stored for each read content type (per user) in the database.', + '#default_value' => variable_get('recently_read_max_entries', 10), + '#required' => TRUE + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Save configuration') + ); + + return $form; +} + + +function recently_read_settings_validate($form, &$form_state) { + $max = $form_state['values']['max_entries']; + if (!is_numeric($max) || $max < 1) { + form_set_error('max_entries', t('%field must be a positive integer value.', + array('%field' => $form['max_entries']['#title']) + )); + } +} + + +function recently_read_settings_submit($form, &$form_state) { + $selected = array(); + foreach ($form_state['values']['node_types'] as $value) { + if ($value) { + $selected[] = $value; + } + } + variable_set('recently_read_node_types', $selected); + variable_set('recently_read_max_entries', $form_state['values']['max_entries']); + variable_set('recently_read_anonymous_enabled', $form_state['values']['anonymous_enabled']); + drupal_set_message(t('The configuration options have been saved.')); +} + + +/* + * Function that checks if a specific node type history tracking has been enabled + */ +function recently_read_is_enabled($node_type) { + $enabled_types = variable_get('recently_read_node_types', array('page', 'story')); + return in_array($node_type, $enabled_types); +} + + +/* + * Get a list of recently read items by node types and for a specific user, + * sorted by read date. + * + * @param $node_types + * An array of node types. + * + * @param $user_id + * Id of a user whose list is returned. + * + * @param $limit + * Number of items to return (zero to return all) + * + * @return + * An array of recently read items. Each item is an array. + * Properties of the item: nid, title, type, timestamp + */ +function recently_read_get_read_items($node_types, $user_id, $limit = 0) { + // normalize arguments + if (!is_array($node_types)) { + $node_types = array($node_types); + } + + if ($limit == 0) { + $limit = variable_get('recently_read_max_entries', 10) * count($node_types); + } + + // get history from _SESSION variable if anonymous + if ($user_id==0 && variable_get('recently_read_anonymous_enabled', FALSE)) { + $items = array(); + foreach ($node_types as $node_type) { + $key = "recently_read-$node_type"; + if (isset($_SESSION[$key]) && is_array($_SESSION[$key])) { + $items = $items + $_SESSION[$key]; + } + } + usort($items, '_recently_read_sort_fcn'); + $items = array_slice($items, 0, $limit); + } + + // get history from database if authenticated + if ($user_id > 0) { + // make a list of links to recently read nodes which are published + $placeholders = db_placeholders($node_types, 'text'); + + // prepare args for sql query + $args = array($user_id); + $args = array_merge($args, $node_types); + $args[] = $limit; + $result = db_query(db_rewrite_sql("SELECT n.nid, n.title, n.type, rr.timestamp FROM {node} n + INNER JOIN {recently_read_nodes} rr + ON n.nid = rr.nid WHERE rr.uid = %d AND n.status = 1 AND n.type IN($placeholders) + ORDER BY rr.timestamp DESC + LIMIT 0, %d"), + $args + ); + + $items = array(); + while ($row = db_fetch_array($result)) { + $items[] = $row; + } + } + + return $items; +} + + +/* + * Disables page caching. Call this function if you want to display recently read content (i.e. block). + */ +function recently_read_disable_page_cache() { + $GLOBALS['conf']['cache'] = FALSE; +} + + +/* + * Return a themed recently read item. + * + * @param $item + * An object containing the properties of the item. + * Properties used: nid, title, type, timestamp + * @return + * A themed HTML string containing a link to the recently read item. + */ +function theme_recently_read_item($item) { + return l($item['title'], 'node/' . $item['nid']); +} + + +/** + * Return a themed list of recently read items. + * + * @param $items + * An array of recently read items to be displayed in the list. + * @return + * A string containing the list output. + * + */ +function theme_recently_read_item_list($items) { + if (count($items)==0) { + return t('Nothing has been read yet.'); + } + + // theme each individual item on the list + foreach ($items as &$item) { + $item = theme('recently_read_item', $item); + } + + // theme the list + return theme('item_list', $items); +} + + +/* + * Compare function for sorting recently read items + */ +function _recently_read_sort_fcn($a, $b) { + $delta = $b['timestamp'] - $a['timestamp']; + if ($delta > 0) return 1; + if ($delta < 0) return -1; + return 0; +} \ No newline at end of file