modules/acidfree/acidfree.module

<?php
/* $Id: acidfree.module 486 2007-05-10 13:47:08Z vhmauery $ */

/*
Acidfree Photo Albums for Drupal
Copyright (C) 2005 Vernon Mauery

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
*/

/**
 * @file
 * Acidfree implements a better photo album than gallery.  Better being
 * defined as doing it The Right Way (TM).  Acidfree was designed as a
 * node based system and written to work seamlessly with Drupal. 
 *
 */

/*
TODO:
 * add some ajax love
 * write an xmlrpc hook
 * 
 */

define('ALBUM_PAGER', 0);
define('ELEMENT_PAGER', 1);
define('PAGER_STRING', "page");

/**
 * Acidfree Classes
 * Each class must support a basic register function and several
 * callbacks that are used.  Specifically, a class named 'foo'
 * would be implemented in a file called class_foo.inc and be
 * required to implement the following hooks:
 * class_foo_init() - returns an object that has info about the class:
    $class->class = 'foo';
    $class->name = t('foo');
    $class->addme = t('Add a foo');
    $class->mime_ext = Array('bin/foo'=>'foo');
    $class->form_alter = '_class_foo_form_alter';
    $class->nodeapi = '_class_foo_nodeapi';
    $class->access = 'create new foo';
 * theme_acidfree_print_full_foo(&$node) - called from acidfree_view()
 * theme_acidfree_print_thumb_foo(&$node, &$parent=null, $offset=0)
 *      - called theme_acidfree_print_full_album or the block hook
 */

/**
 * call an arbitrary method with arbitrary arguments
 *
 * note that if you are calling a function that only requires a single arg
 * that is an array, you must pass it in inside of an array like:
 * $bob = array(2,3,4); acidfree_call('chump', array($bob));
 * if you don't chump will be called as chump(2,3,4)
 * which probably isn't what you want
 *
 * passing args by reference is allowed, but you must make the call like:
 * acidfree_call('chump', array(&$foo, $baz));
 * where $foo would be passed by reference and $baz wouldn't.  a call like:
 * acidfree_call('chump', $foo, $baz) will pass by value
 */
function acidfree_call($function) {
    $args = false;
    $argc = func_num_args();
    if ($argc > 2) {
        $args = func_get_args();
        array_shift($args);
    } elseif ($argc != 1) {
        $args = func_get_arg(1);
        if (!is_array($args)) {
            $args = func_get_args();
            array_shift($args);
        }
    }
    if (!$args)
        $args = array();
    if (function_exists($function))
        return call_user_func_array($function, $args);
    return null;
}

function acidfree_node_info() {
    return array(
            'acidfree' => array(
                'name' => t('album'),
                'module' => 'acidfree',
                'description' => t("Acidfree albums are used for the categorization of images and videos."),
                )
            );
}

function acidfree_load(&$node) {
    $items = db_fetch_object(db_query("SELECT * FROM {acidfree_album} WHERE aid=%d", $node->nid));
    if (isset($items->thumb) && !$items->thumb) {
        $items->thumb = '';
    }
    return $items;
}

function acidfree_insert(&$node) {
    $vocab = acidfree_get_vocab_id();
    $term = array(
            'vid' => $vocab,
            'name' => $node->title,
            'description' => $node->body,
            'weight' => $node->weight,
            'parent' => $node->taxonomy[$vocab],
        );
    taxonomy_save_term($term);
    $node->tid = $term['tid'];
    db_query("INSERT INTO {acidfree_album} (aid,tid,thumb,share,order_by,view) values ".
        "(%d, %d, '%s', %d, '%s', '%s')", $node->nid, $node->tid, $node->thumb,
        $node->share, $node->order_by, $node->view);
    if (function_exists('views_invalidate_cache'))
        views_invalidate_cache();
}

function acidfree_update(&$node) {
    $vocab = acidfree_get_vocab_id();
    $term = array(
            'vid' => $vocab,
            'tid' => $node->tid,
            'name' => $node->title,
            'description' => $node->body,
            'weight' => $node->weight,
            'parent' => $node->taxonomy[$vocab],
        );
    taxonomy_save_term($term);
    db_query("UPDATE {acidfree_album} SET thumb='%s', share=%d, order_by='%s', view='%s' WHERE aid=%d",
        $node->thumb, $node->share, $node->order_by, $node->view, $node->nid);
    if (function_exists('views_invalidate_cache'))
        views_invalidate_cache();
}

function acidfree_delete(&$node) {
    taxonomy_del_term($node->tid);
    db_query("DELETE FROM {acidfree_album} WHERE aid=%d", $node->nid);
}

function acidfree_view($node, $teaser = FALSE, $page = FALSE) {
    if ($page) {
        $view = "album_{$node->view}_view";
        $node->content['body'] = array(
                '#value' => acidfree_album_view($view, $node->tid),
                //'#value' => '<div class="clear-block">' . $output . '</div>',
                '#weight' => 0,
            );
        return $node;
    } else {
        static $head_set;
        if (!$head_set) {
            $size = _image_get_dimensions('thumbnail');
            // 5px padding + 1px border on both sides of image +
            // 5px padding and 2px border on both sides of acidfree-item
            // gives 26. Height needs more because it contains text underneath.
            $style = '<style type="text/css" media="all">';
            $style .= '.acidfree-cell{width:' . ($size['width'] + 26) . 'px;}';
            $style .= '.acidfree .acidfree-cell{height:' . ($size['height'] + 45) . 'px;}';
            $style .= '</style>';
            drupal_set_html_head($style);
            $head_set = TRUE;
        }

        $node->readmore = (strlen($node->teaser) < strlen($node->body));
        $output = theme("acidfree_print_thumb_acidfree", $node);
        $output .= check_markup($node->teaser, $node->format, FALSE);
        $node->content['body'] = array(
                '#value' => '<div class="clear-block">' . $output . '</div>',
                '#weight' => 0,
            );
        return $node;
    }
}

function acidfree_form(&$node) {
    if ($node->nid && !strstr($_REQUEST['q'], 'contents')) {
        drupal_set_title(t('Edit %title', array('%title' => $node->title)));
        drupal_set_breadcrumb(acidfree_make_breadcrumbs($node));
    }
    $form = array();
    $form['title'] = array(
            '#type' => 'textfield',
            '#title' => t('Title'),
            '#default_value' => $node->title,
            '#required' => true,
            '#weight' => -20,
        );
    if (!isset($node->tid)) {
        $parent = _path_match('node', 'add', 'acidfree', '%d');
        $parent = acidfree_get_node_by_id($parent[0]);
        $parent = $parent->tid;
    } else {
        $parent = taxonomy_get_parents($node->tid);
        $parent = array_keys($parent);
        $parent = $parent[0];
    }
    // HACK -- taxonomy rudely assumes that if $form['taxonomy'] is set
    // then in its form_alter hook, it puts it into a field set.  grrr.
    // so we fight back by calling it parent here and renaming it to
    // taxonomy in our form_alter, which is call after taxonomy's
    global $user;
    if (isset($node->tid) && ($node->tid == acidfree_get_root() || $node->tid == $user->acidfree_album)) {
        $form['parent'] = array('#type' => 'hidden', '#value' => 0);
    } else {
        $form['parent'] = _acidfree_parent_select($parent, $node->tid);
    }
    $form['body'] = array(
            '#type' => 'textarea',
            '#title' => t('Body'),
            '#default_value' => $node->body,
            '#weight' => -1,
        );
    $form['view'] = array(
            '#type' => 'select',
            '#title' => t('Default album view'),
            '#options' => array(
                    'grid' => t('Grid view'),
                    'list' => t('List view'),
                ),
            '#default_value' => $node->view,
            '#weight' => 0,
        );
    $form['order_by'] = array(
            '#type' => 'select',
            '#title' => t('Sort album by'),
            '#options' => array(
                    '<default>' => t('Use global settings'),
                    'node.nid DESC' => t('Latest post first'),
                    'node.nid ASC' => t('Posted order'),
                    'node.title ASC' => t('Alphabetical order'),
                    'node.created ASC' => t('Chronological order by creation date'),
                ),
            '#default_value' => $node->order_by,
            '#weight' => -1,
            '#attributes' => array('class' => 'order-by'),
        );
    if ($node->nid) {
        $thumb_options['0'] = 'Random';
        $children = _acidfree_get_children($node->tid, -1, 0);
        if (!is_array($children)) {
            if (count($children) == 1)
                $children = Array($children);
            else
                $children = Array();
        }
        foreach ($children as $child) {
            $child = acidfree_get_node_by_id($child);
            if (strlen($child->title) > 20)
                $title = substr($child->title, 0, 20)."...";
            else
                $title = $child->title;
            $thumb_options[$child->nid] = check_plain($title);
        }
        // in album contents mode, this would be a duplicate thumbnail
        if (!strstr($_GET['q'], 'contents')) {
            $prefix = theme('acidfree_print_thumb_acidfree', $node);
            $description = t("Select a fixed album thumbnail or select 'Random' to have a random thumbnail appear for the album thumbnail");
        }
        global $base_url;
        $form['thumb'] = array(
                '#type' => 'select',
                '#prefix' => $prefix,
                '#title' => t('Album thumbnail'),
                '#description' => $description,
                '#default_value' => $node->thumb,
                '#options' => $thumb_options,
                '#attributes' => array(
                        'class' => 'order-by',
                        'onchange' => "set_thumb('$base_url', this, {$node->nid}, ".count($children).")",
                    ),
                '#acidfree_form' => true,
            );
    } else {
        $form['thumb'] = array('#type' => 'hidden', '#value' => '');
    }
    $form['share'] = array(
            '#type' => 'checkbox',
            '#title' => t('Allow others to post items to this album'),
            '#default_value' => $node->share,
            '#weight' => -1,
        );
    $term = taxonomy_get_term($node->tid);
    $form['weight'] = array(
            '#type' => 'weight',
            '#title' => t('Weight'),
            '#default_value' => $term->weight,
            '#description' => t('In listings, the heavier albums will sink and the lighter albums will be positioned nearer the top.'),
        );
    return $form;
}

/**
 * Implementation of hook_help().
 *
 * Throughout Drupal, hook_help() is used to display help text at the top of
 * pages. Some other parts of Drupal pages get explanatory text from these hooks
 * as well. We use it here to provide a description of the module on the
 * module administration page.
 */
function acidfree_help($section) {
    global $acidfree_types;
    switch ($section) {
        case 'admin/settings/modules#description':
            // This description is shown in the listing at admin/settings/modules.
            return t('A better photo album than Gallery or Album. Acidfree is node based and well integrated into Drupal.');
        case 'node/add#acidfree':
            // This description shows up when users click "create content."
            return t('Add an album here.  Other elements you can add are in the \'create content\' menu.');
        case 'admin/help/acidfree':
            return t('<p>Acidfree is an album system that has the ability to store any kind of media (assuming the class is existent.)  Currently implemented are %types.  Following the example of one of the currently implemented classes, it is easy to create a new media type.</p>', array('%types' => implode(', ', array_keys($acidfree_types)))); 
        case 'admin/help#acidfree':
            return t('<p>Because Acidfree is more than simply a storage and viewing module, it requires some depenencies for the album management.  First, it requires the Filemanager module.  Until the Filemanager gets patched to have the exended API that Acidfree requires, Acidfree will ship with a patch for the Filemanager.  Second, it requires some form of image manipulation.  Drupal provides a frontend to the GD library that can do what is required.  Or, if you would rather use ImageMagick or libmagick (php-imagick module), set that up (copy the image.*.inc files to the includes directory) and select it.  Finally, if you want lossless rotations for your images, you will require jpegtran or exiftran.</p><p>For video thumbnailing, there are three options.  You can choose a static image for all your videos (no thumbnail), upload your own thumbnail (user thumbnail) or have mplayer thumbnail them automatically for you.  If you choose the first option, you will be asked to give the dimensions of the video so it can be displayed correctly in the \'full\' view.  With option two, be sure to upload a thumbnail that is the same dimensions as the actual video (grab a frame from the video, do not resize it.)  The third option obviously implies that you have mplayer and all the win32 codecs installed on your <b>server</b> and that you are allowed to exec other programs (i.e., not running in safe mode.).  ');
        case 'admin/settings/acidfree':
            return t('Change these settings to however you like.  You are w00t, afterall.');
        case 'admin/content/types/acidfree':
            return t("The common attributes that Acidfree will have are: 'Sticky at top of lists', which allows the albums to be sorted before the other media types (image, video, etc.) in the various album views;  and *not* 'Promoted to front page' because that would make all the albums show up at the top of the front page, which is probably not desirable.");
        default:
            return "";
    }
}

function include_acidfree_files($reset=false) {
    global $acidfree_types;
    static $loaded = false;

    if ($loaded && !$reset) {
      return;
    }

    if ($reset) {
        variable_set('acidfree_types', array());
    }

    $acidfree_types = variable_get('acidfree_types', array());
    $acidfree_base = dirname(drupal_get_filename('module', 'acidfree'));
    if (!$acidfree_types) {
        foreach (glob($acidfree_base.DIRECTORY_SEPARATOR.'class_*.inc') as $classfile) {
            require_once($classfile);
            $type = acidfree_call(basename($classfile, ".inc") . "_register");
            if ($type->class)
                $acidfree_types[$type->class] = $type;
        }
        variable_set('acidfree_types', $acidfree_types);
    } else {
        foreach ($acidfree_types as $name => $class) {
            $file = $acidfree_base.DIRECTORY_SEPARATOR."class_{$name}.inc";
            if (file_exists($file)) {
                require_once($file);
            } else {
                include_acidfree_files(true);
            }
        }
    }
    require_once $acidfree_base.DIRECTORY_SEPARATOR.'image_manip.inc';
    $loaded = true;
}

function acidfree_menu($may_cache) {
    global $acidfree_types, $user;
    $items = array();

    include_acidfree_files();
    if ($may_cache) {
        $items[] = array(
                'path' => 'node/add/acidfree',
                'title' => t('Album'),
                'access' => user_access('create acidfree albums'),
                'callback' => 'node_add',
                'callback arguments' => array('acidfree'),
            );
        $items[] = array('path' => 'admin/settings/acidfree',
                'title' => t('Acidfree settings'),
                'callback' => 'drupal_get_form',
                'callback arguments' => array('acidfree_admin_settings'),
                'description' => t('Site-wide Acidfree settings.'),
                'access' => user_access('administer site configuration'),
                'type' => MENU_NORMAL_ITEM,
            );
        $items[] = array('path' => 'acidfree',
                'callback' => 'acidfree_page',
                'title' => t('Acidfree albums'),
                'access' => user_access('access content'),
                'type' => MENU_SUGGESTED_ITEM);
        // acidfree_init stuff
        $create_acidfree_elements = false;
        $default_class_callback = false;
        $items[] = Array('path' => 'node/add/acidfree/mass', 'title' => t('Mass import'),
                'access' => user_access('acidfree mass import'),
                'callback' => 'acidfree_mass_import_form',
                'type' => MENU_NORMAL_ITEM);
        $items[] = array('path' => 'acidfree/thumbnail',
                'callback' => 'acidfree_fetch_thumb',
                'type' => 0,
            );
    } else {
        $acidfree_base = drupal_get_path('module', 'acidfree');
        drupal_add_css("$acidfree_base/acidfree.css", 'module', 'all');

        $path = explode('/', $_GET['q']);
        if ($path[0] == 'node' && is_numeric($path[1])) {
            $album = acidfree_get_node_by_id($path[1]);
            if ($album && $album->type == 'acidfree') {
                $items[] = Array('path' => "node/{$path[1]}/contents",
                        'access' => node_access('update', $album),
                        'title' => t('Album contents'),
                        'callback' => 'drupal_get_form',
                        'callback arguments' => array('acidfree_album_contents', $album->tid),
                        'type' => MENU_LOCAL_TASK);
                if (variable_get('acidfree_show_alternate_view', true)) {
                    $other_view = array('grid' => 'list', 'list' => 'grid');
                    $view_name = array('grid' => t('Grid'), 'list' => t('List'));
                    $view = $other_view[$album->view];
                    $items[] = Array('path' => "node/{$path[1]}/{$view}",
                            'access' => 1,
                            'title' => $view_name[$view],
                            'callback' => 'acidfree_album_view',
                            'callback arguments' => array("album_{$view}_view", $album->tid),
                            'type' => MENU_LOCAL_TASK,
                            'weight' => -4,
                        );
                }
            }
        }
        if (variable_get('acidfree_per_user_albums', false)) {
            $items[] = array('path' => 'user/acidfree', 'title' => t('My Acidfree Albums'),
                    'access' => user_access('get a per-user album'),
                    'callback' => 'acidfree_page',
                    'type' => MENU_SUGGESTED_ITEM,
                );
        }
        drupal_add_js(drupal_get_path('module', 'acidfree').'/acidfree.js');
    }
    return $items;
}

function acidfree_fetch_thumb($nid=0) {
    if ($nid == 0 || !($node = acidfree_get_node_by_id($nid))) {
        return drupal_not_found();
    }
    if (!node_access('view', $node)) {
        return drupal_access_denied();
    }
    $file_path = _acidfree_get_thumb_path($node);
    file_transfer($file_path, array('Content-Type: '.acidfree_mime($file_path), 'Content-Length: '. filesize($filepath), 'Content-Disposition: filename=' . basename($file_path)));
}

function _acidfree_can_create() {
    return user_access('create images') ||
           user_access('create video') ||
           user_access('create acidfree albums');
}

function _acidfree_add_pager(&$node) {
    // determine the acidfree term -- if no term, bail out
    if (!$node->taxonomy) {
        return;
    }

    // FIXME: this is part of our ugly pager
    $parent = _acidfree_get_parent($node);
    $parent = $parent->tid;
    $offset = _acidfree_get_offset_in_parent($parent, $node);
    $p = "pid={$parent}";
    $pager = _acidfree_make_pager_string(array(ELEMENT_PAGER=>"$offset"));
    $nid = $node->nid;

    // Node ID was present so just hack in the other elements so the system can deal with it. No redirect needed
    $_GET[PAGER_STRING] = $pager;
    $_GET['pid'] = $parent->nid;
    // END: ugly hack

    $node->content['acidfree_pager'] = array(
            '#weight' => -19,
            '#value' => acidfree_pager_creator($node),
        );
}

/**
 * Implementation of hook_nodeapi
 */
function acidfree_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
    switch ($op) {
    case "delete":
        break;
    case "insert":
        break;
    case "load":
        break;
    case "prepare":
        break;
    case "search result":
        break;
    case "print":
        break;
    case "update":
        // if it is an image node, check to see if we need to rotate it
        if ($node->type == 'image') {
            _class_image_rotate($node);
        }
        break;
    case "submit":
        break;
    case "update index":
        break;
    case "validate":
        break;
    case "view":
        if (($node->type == 'image' || $node->type == 'video') && !$teaser) {
            $node->content['body']['#weight'] = 1;
            if ($page) {
                drupal_set_breadcrumb(acidfree_make_breadcrumbs($node));
                _acidfree_add_pager($node);
            }
            acidfree_call('_class_'.$node->type.'_view_alter', array(&$node));
        }
        break;
    case "rss item":
        break;
    }
}

function &acidfree_get_node_by_id($nid) {
    $types = array('image', 'video', 'acidfree');
    $node =& node_load(array('nid' => $nid));
    if (in_array($node->type, $types))
        return $node;
    return null;
}

function _acidfree_album_is_shared($option) {
    global $user;
    $tid = array_keys($option->option);
    $node = _album_from_tid($tid[0]);
    return ($node->share || $node->uid == $user->uid);
}

function _acidfree_filter_taxonomy(&$taxonomy) {
    if (!user_access('can upload to any album')) {
        $albums = array();
        if (!is_array($taxonomy) || !is_array($taxonomy['#options']))
            return;
        $taxonomy['#options'] = array_filter($taxonomy['#options'], '_acidfree_album_is_shared');
    }
}

function acidfree_form_alter($form_id, &$form) {
  global $acidfree_types;
  //dump_msg($form);
  $q = $_GET['q'];
  switch ($form_id) {
    case 'acidfree_node_form':
      acidfree_call($acidfree_types['album']->form_alter, array($form_id, &$form));
        break;
    case 'image_node_form':
      acidfree_call($acidfree_types['image']->form_alter, array($form_id, &$form));
      break;
    case 'video_node_form':
      acidfree_call($acidfree_types['video']->form_alter, array($form_id, &$form));
      break;
    case 'system_modules':
      include_acidfree_files(true);
      break;
    default:
      //drupal_set_message("form_alter: $form_id (not modified)");
      break;
  }
}

function _is_int($value) {
    return (is_numeric($value) && ((int)$value == $value));
}
function valid_integer($value, $min=null, $max=null) {
    if (is_null($min)) {
        return _is_int($value);
    }
    if (is_null($max)) {
        return (_is_int($value) && $value >= $min);
    }
    return (_is_int($value) && $value >= $min && $value <= $max);
}

function acidfree_settings_validate($form_id, $values, &$form) {
    if (!valid_integer($values['acidfree_num_thumbs'], 0)) {
        form_set_error('acidfree_num_thumbs', t('Thumbnails per page must be a non-negative integer'));
    }
    if (!valid_integer($values['acidfree_extra_length'], 0)) {
        form_set_error('acidfree-extra-length', t('Thumbnail padding must be a non-negative integer'));
    }
}

function acidfree_settings_submit($form, &$edit) {
    if ($edit['acidfree_order_force']) {
        db_query("UPDATE {acidfree_album} SET order_by = '<default>'");
    }
    $node = new stdClass();
    $node->type = 'acidfree';
    _acidfree_set_node_defaults($node);
    if ($node->sticky != $edit['acidfree_album_sticky']) {
        $name = 'node_options_acidfree';
        $options = variable_get($name, array());
        if ($edit['acidfree_album_sticky']) {
            $options[] = 'sticky';
        } else {
            $options = array_filter($options, create_function('$v', 'return ($v != "sticky");'));
        }
        variable_set($name, $options);
        db_query("UPDATE {node} SET sticky=%d WHERE type='acidfree'", $edit['acidfree_album_sticky']);
    }
    foreach ($edit as $key => $value) {
        variable_set($key, $value);
    }
}

/**
 * Implementation of hook_settings
 */
function acidfree_admin_settings() {
    $form = array();
    $form['#validate'] = array('acidfree_settings_validate' => array());
    $form['#submit'] = array('acidfree_settings_submit' => array());
    $form['general'] = array(
            '#type' => 'fieldset',
            '#title' => t('General Settings'),
        );
    $form['general']['acidfree_per_user_albums'] = array(
            '#type' => 'checkbox',
            '#title' => t('Per user albums'),
            '#description' => t('This options will allow each user to have a top-level album of their own.  The per user album is located at user/acidfree if logged in and acidfree/user/nnn for each individual album.'),
            '#default_value' => variable_get('acidfree_per_user_albums', false),
        );
    $exiftran_path = variable_get('acidfree_path_to_exiftran', '/usr/bin/exiftran');
    $jpegtran_path = variable_get('acidfree_path_to_jpegtran', '/usr/bin/jpegtran');
    if (ini_get('safe_mode')) {
        $safe_dirs = explode(PATH_SEPARATOR, ini_get('safe_mode_exec_dir'));
        array_walk($safe_dirs, create_function('&$a, $b', '$a = realpath($a);'));
        if (!in_array(dirname($jpegtran_path), $safe_dirs) &&
            !in_array(dirname($exiftran_path), $safe_dirs)) {
            drupal_set_message(t('Neither exiftran nor jpegtran executables are in the safe_mode_exec_dir (%safe_dir) &mdash; lossy jpeg rotation will be used instead', array('%safe_dir' => $safe_dir)));
        }
    }
    if (!is_executable($exiftran_path) && !is_executable($jpegtran_path))
        drupal_set_message(t('Neither exiftran nor jpegtran are available &mdash; lossy jpeg rotation will be used instead'));
    drupal_add_js(drupal_get_path('module', 'acidfree').'/acidfree.js');
    $form['display'] = array(
            '#type' => 'fieldset',
            '#title' => t('Acidfree Display'),
        );
    $form['display']['acidfree_show_alternate_view'] = array(
            '#type' => 'checkbox',
            '#title' => t('Show alternative album view'),
            '#default_value' => variable_get('acidfree_show_alternate_view', true),
            '#description' => t('Albums normally have two views: grid and list.  This option controls whether or not when viewing the album, users can switch to the alternate view.  Which view is the default view is set individually in each album'),
        );
    $form['display']['acidfree_order'] = array(
            '#type' => 'select',
            '#title' => t('Sort albums by'),
            '#default_value' => variable_get('acidfree_order', 'node.nid DESC'),
            '#options' => array(
                    'node.nid DESC' => t('Latest post first'),
                    'node.nid ASC' => t('Posted order'),
                    'node.title ASC' => t('Alphabetical order'),
                    'node.created ASC' => t('Chronological order by creation date'),
                ),
        );
    $form['display']['acidfree_order_force'] = array(
            '#type' => 'checkbox',
            '#title' => t('Sort all albums'),
            '#default_value' => 0,
            '#description' => t('Force all albums to use this selected sort order'),
        );
    $node = new stdClass();
    $node->type = 'acidfree';
    _acidfree_set_node_defaults($node);
    $form['display']['acidfree_album_sticky'] = array(
            '#type' => 'checkbox',
            '#title' => t('List albums first'),
            '#default_value' => $node->sticky,
            '#description' => t("Show albums first in all lists (marks them as 'sticky')"),
        );
    $form['display']['acidfree_num_thumbs'] = array(
            '#type' => 'textfield',
            '#title' => t('Thumbnails per page'),
            '#size' => 5,
            '#maxlength' => 10,
            '#default_value' => variable_get('acidfree_num_thumbs', 15),
            '#description' => t('Enter 0 for unlimited')
        );
    $form['display']['acidfree_filter_caption'] = array(
            '#type' => 'checkbox',
            '#title' => t('Show image title as default caption for inline images'),
            '#default_value' => variable_get('acidfree_filter_caption', false),
        );
    $form['display']['acidfree_extra_length'] = array(
      '#type' => 'textfield',
      '#size' => 3,
      '#title' => t('Amount of padding/border on each side of thumbnail image'),
      '#default_value' => variable_get('acidfree_extra_length',12),
      '#description' => t('In pixels. Only needs to be changed if you modify the padding/border around the thumbnail.')
    );

    if (!image_get_toolkit())
        drupal_set_message(t('No image toolkit has been properly installed or configured.  Go to admin/settings to fix this.'), 'error');
    $form['image_manip'] = array(
            '#type' => 'fieldset',
            '#title' => t('Image Manipulation'),
        );
    $form['image_manip']['acidfree_path_to_exiftran'] = array(
            '#type' => 'textfield',
            '#default_value' => $exiftran_path,
            '#description' => t('exiftran provides lossless rotation of jpeg images and keeps EXIF information.  If you provide a working path, Acidfree will try to use it.'),
        );
    $form['image_manip']['acidfree_path_to_jpegtran'] = array(
        '#type' => 'textfield',
        '#default_value' => $jpegtran_path,
        '#description' => t('jpegtran provides lossless rotation of jpeg images and can somewhat munge the EXIF information.  If you provide a working path, Acidfree will try to use it.'),
    );
    if (function_exists('_class_video_manipulation_options'))
        $form = array_merge($form, acidfree_call('_class_video_manipulation_options'));

    return system_settings_form($form);
}

/**
 * Implementation of hook_access().
 *
 * Node modules may implement node_access() to determine the operations
 * users may perform on nodes. This example uses a very common access pattern.
 */
function acidfree_access($op, $node=null) {
    global $user;

    if ($op == 'create') {
        // Only users with permission to do so may create this node type.
        return user_access('create acidfree albums');
    }

    // Users who create a node may edit or delete it later, assuming they have the
    // necessary permissions.
    if ($op == 'update' || $op == 'delete') {
        if (user_access('edit own acidfree albums') && ($user->uid == $node->uid)) {
            return TRUE;
        }
    }
}

/**
 * Implementation of hook_perm().
 *
 * Since we are limiting the ability to create new nodes to certain users,
 * we need to define what those permissions are here. We also define a permission
 * to allow users to edit the nodes they created.
 */
function acidfree_perm() {
    $perms = Array();
    $perms[] = 'create acidfree albums';
    $perms[] = 'edit own acidfree albums';
    $perms[] = 'acidfree mass import';
    $perms[] = 'can upload to any album';
    if (variable_get('acidfree_per_user_albums', 0)) {
        $perms[] = 'get a per-user album';
    }
    return $perms;
}

/**
 * Implementation of hook_link().
 *
 * This is implemented so that an edit link is displayed for users who have
 * the rights to edit a node.
 */
function acidfree_link($type, $node = 0, $main) {
    $links = array();
    if ($type == 'node' && $node->type == 'acidfree') {
        // Don't display a redundant edit link if they are node administrators.
        if (acidfree_access('update', $node) && !user_access('administer nodes')) {
            // determine whether or not we are actually viewing an album or a node
            $links['acidfree_edit_node'] = array(
                    'title' => t('edit this album'),
                    'href' => "node/{$node->nid}/edit",
                );
        }
    }
    return $links;
}

// FIXME: do we still need a link_alter to get rid of book module's links

function _acidfree_create_quick_links(&$album) {
    global $acidfree_types;
    if (isset($album->nid)) {
        $tpath = "/{$album->nid}";
    } else {
        $tpath = "";
    }
    $links = Array();
    $show_box = node_access('update', $album) ||
        (_acidfree_can_create() && $album->share) ||
        user_access('can upload to any album');
    if (!$show_box) {
        return $links;
    }
    foreach ($acidfree_types as $type) {
        if (user_access($type->access)) {
            $type->path = ($type->class == 'album') ? 'acidfree' : $type->class;
            $links[] = l($type->addme, "node/add/{$type->path}{$tpath}");
        }
    }
    if (user_access('acidfree mass import'))
        $links[] = l(t('Mass import'), "node/add/acidfree/mass{$tpath}");
    return theme('item_list',$links);
}

function acidfree_get_block_nodes($order, $count, $albums=array()) {
    if ($order == 'counts') {
        $order = 'votes DESC';
        $join = 'INNER JOIN {node_counter} c on n.nid=c.nid ';
        $select = ', ABS(c.daycount*10 + c.totalcount) AS votes';
    }
    if (count($albums) > 0) {
        $terms = implode(',', $albums);
        $query = "SELECT n.nid FROM {node} n ".
            "INNER JOIN {term_node} t on n.nid=t.nid ".
            "WHERE n.type IN ('image', 'video') AND ".
            "t.tid IN ($terms) AND n.status=1 ".
            "ORDER BY $order LIMIT $count";
    } else {
        $query = "SELECT n.nid $select FROM {node} n $join".
            "WHERE n.type IN ('image', 'video') AND n.status=1 ".
            "ORDER BY $order LIMIT $count";
    }
    $query = db_rewrite_sql($query);
    $result = db_query($query);
    $nodes = Array();
    while ($row = db_fetch_object($result)) {
        $nodes[] = acidfree_get_node_by_id($row->nid);
    }
    return $nodes;
}

function theme_acidfree_block_contents($node_array) {
    $nodes =& $node_array[0];
    foreach ($nodes as $node) {
        $output .= "<div class='block-cell'>";
        $output .= theme("acidfree_print_thumb_{$node->type}", $node);
        $output .= "</div>";
    }
    $output .= "<div class='block-bottom'>&nbsp;</div>\n";
    return $output;
}

function acidfree_block($op = 'list', $delta = 0, $edit=array()) {
    $titles = array(
        0=>variable_get("acidfree_block_0_title", t('Recent Acidfree items')),
        1=>variable_get("acidfree_block_1_title", t('Favorite Acidfree items')),
        2=>variable_get("acidfree_block_2_title", t('Random Acidfree items')),
        3=>variable_get("acidfree_block_3_title", t('Add Acidfree items')),
    );
    switch ($op) {
    case 'list':
        $blocks[0]['info'] = t('Acidfree item recent selection');
        $blocks[1]['info'] = t('Acidfree item favorite selection');
        $blocks[2]['info'] = t('Acidfree item random selection');
        $blocks[3]['info'] = t('Add Acidfree items quick links');
        return $blocks;
    case 'view':
        if (user_access('access content')) {
            $albums = array();
            $block['subject'] = $titles[$delta];
            switch ($delta) {
                case 0:
                    $order = "nid DESC";
                    break;
                case 1:
                    $order = "counts";
                    break;
                case 2:
                    $all_albums = variable_get('acidfree_block_2_all_albums', 1);
                    if (!$all_albums) {
                        $albums = variable_get('acidfree_block_2_random_albums', array());
                    }
                    $order = "RAND()";
                    break;
                case 3:
                    global $acidfree_types;
                    $q = explode('/', $_GET['q']);
                    if ($q[0] == 'node' && is_numeric($q[1])) {
                        $node = acidfree_get_node_by_id($q[1]);
                    } else if ($type = _path_match('node', 'add', '%s', '%?d')) {
                        if (in_array($type[0], array_keys($acidfree_types)) ||
                                $type[0] == 'acidfree') {
                            $node = acidfree_get_node_by_id($q[3]);
                        }
                    } else if (strstr($_GET['q'], 'node/add/acidfree')) {
                        $node = acidfree_get_node_by_id($q[4]);
                    }
                    if (isset($node)) {
                        $block['content'] = _acidfree_create_quick_links($node);
                    }
                    break;
                default:
                    break;
            }
            if ($delta >= 0 && $delta <= 2) {
                $nodes = acidfree_get_block_nodes($order,
                    variable_get("acidfree_block_{$delta}_items", 3), $albums);
                $block['content'] = theme('acidfree_block_contents', array(&$nodes));
            } 
            return $block; 
        }
    case 'configure':
        {
            $fields = array();
            if ($delta == 3)
                return $fields;
            $fields["acidfree_block_{$delta}_items"] = array(
                    '#type' => 'select',
                    '#title' => t('Number of items'),
                    '#default_value' => variable_get("acidfree_block_{$delta}_items", '5'),
                    '#options' => drupal_map_assoc(range(1,20)),
                );
            if ($delta == 2) {
                drupal_add_js(drupal_get_path('module', 'acidfree').'/acidfree.js');
                $all_albums = variable_get('acidfree_block_2_all_albums', 1);
                $fields['acidfree_block_2_all_albums'] = array(
                        '#type' => 'checkbox',
                        '#title' => t('Include items from all albums'),
                        '#default_value' => $all_albums,
                        '#attributes' => array('onchange' => 'toggle_album_select(this);'),
                    );
                $random_selected = variable_get('acidfree_block_2_random_albums', array());
                $fields['acidfree_block_2_random_albums'] = _taxonomy_term_select(
                        t('Select random items from these albums'), null, $random_selected, acidfree_get_vocab_id(), t('description'), true, false);
                if ($all_albums) {
                    $fields['acidfree_block_2_random_albums']['#attributes'] = array('disabled' => 'disabled');
                }
            }
            return $fields;
        }
    case 'save':
        if ($delta == 3)
            break;
        variable_set("acidfree_block_{$delta}_items", $edit["acidfree_block_{$delta}_items"]);
        if ($delta == 2) {
            variable_set('acidfree_block_2_random_albums', $edit['acidfree_block_2_random_albums']);
            variable_set('acidfree_block_2_all_albums', $edit['acidfree_block_2_all_albums'] == 1);
        }
        break;
    }
}

function _acidfree_form_element($item) {
    $el = '#acidfree_form';
    $item = (array) $item;
    return isset($item['#acidfree_form']);
}
function acidfree_form_elements($arr) {
    return array_filter($arr, '_acidfree_form_element');
}

function acidfree_node_form_validate($form_id, &$edit, &$form) {
    if ($form_id != 'acidfree_node_form')
        return;
    // FIXME: should we do this sort of checking on the file?
    // and is this the right place to do it?
    return;
    if ($form['acidfreeupload'] && !file_check_upload('acidfreeupload'))
        form_error($form['acidfreeupload'], t('No file supplied'));
}

function acidfree_test() {
    $errors = 0;
    $output .= "<ol>\n";
    if (module_exists('image')) {
        if (_image_check_settings()) {
            $output .= '<li class="testok">'.t('Image module sanity check passed.').'</li>';
        } else {
            $output .= '<li class="testfail">'.t('Image module sanity check failed. Check the settings at !imgurl and !fsurl.', array('!imgurl'=>'<a href="'.url('admin/settings/image').'">admin/settings/image</a>', '!fsurl'=>'<a href="'.url('admin/settings/file-system').'">admin/settings/file-system</a>')).'</li>';
            $errors++;
        }
    }
    if (module_exists('video_upload')) {
        if (_video_upload_check_settings()) {
            $output .= '<li class="testok">'.t('Video Upload module sanity check passed.').'</li>';
        } else {
            $output .= '<li class="testfail">'.t('Video Upload module sanity check failed. Check the settings at !fsurl.', array('!fsurl'=>'<a href="'.url('admin/settings/file-system').'">admin/settings/file-system</a>')).'</li>';
            $errors++;
        }
    }
    if (file_check_directory(file_directory_temp(), FILE_CREATE_DIRECTORY)) {
        $output .= '<li class="testok">'.t('Temporary path okay.').'</li>';
    } else {
        $output .= '<li class="testfail">'.t('Temporary path does not exist. Check the settings at !fsurl.', array('!fsurl'=>'<a href="'.url('admin/settings/file-system').'">admin/settings/file-system</a>')).'</li>';
        $errors++;
    }
    $modules = array(
            "'acidfree'",
            "'image'",
            "'taxonomy'",
            "'video'",
            "'video_image'",
            "'video_upload'",
        );
    $results = db_query('SELECT name,weight FROM {system} WHERE name IN ('.implode(',', $modules).')');
    while (($row = db_fetch_array($results))) {
        $weights[$row['name']] = $row['weight'];
    }
    $query = "UPDATE {system} SET weight=%d WHERE name='%s'";
    if ($weights['video_image'] < $weights['video_upload']) {
        db_query($query, ++$weights['video_upload'], 'video_image');
        $output .= '<li class="testfail">'.t('Updated %mod module weight.', array('%mod' => 'video_image')).'</li>';
        $errors++;
    } else {
        $output .= '<li class="testok">'.t('%mod module weight okay.', array('%mod' => 'video_image')).'</li>';
    }
    if ($weights['acidfree'] < $weights['image'] ||
        $weights['acidfree'] < $weights['taxonomy'] ||
        $weights['acidfree'] < $weights['video'] ||
        $weights['acidfree'] < $weights['video_image'] ||
        $weights['acidfree'] < $weights['video_upload']) {
        db_query($query, max($weights)+1, 'acidfree');
        $output .= '<li class="testfail">'.t('Updated %mod module weight.', array('%mod' => 'acidfree')).'</li>';
        $errors++;
    } else {
        $output .= '<li class="testok">'.t('%mod module weight okay.', array('%mod' => 'acidfree')).'</li>';
    }
    if (($itk = image_get_toolkit()) && image_toolkit_invoke('check_settings')) {
        $output .= '<li class="testok">'.t('%itk image toolkit installed and properly configured', array('%itk' => $itk)).'</li>';
    } else {
        $output .= '<li class="testfail">'.t('Image toolkit not properly installed or configured.  Go to %url and configure the image toolkit properly.', array('%url' => '<a href="%url">admin/settings</a>', array('%url' => url('admin/settings')))).'</li>';
        $errors++;
    }
    $output .= "</ol>\n";
    if ($errors) {
        $output .= '<p>'.t<