path: root/modules/gallery/helpers/gallery_event.php

<?php defined("SYSPATH") or die("No direct script access.");
/**
 * Gallery - a web based photo album viewer and editor
 * Copyright (C) 2000-2013 Bharat Mediratta
 *
 * 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.
 */

class gallery_event_Core {
  /**
   * Initialization.
   */
  static function gallery_ready() {
    if (!get_cfg_var("date.timezone")) {
      if (!(rand() % 4)) {
        Kohana_Log::add("error", "date.timezone setting not detected in " .
                        get_cfg_var("cfg_file_path") . " falling back to UTC.  " .
                        "Consult http://php.net/manual/function.get-cfg-var.php for help.");
      }
    }

    identity::load_user();
    theme::load_themes();
    locales::set_request_locale();
  }

  static function user_deleted($user) {
    $admin = identity::admin_user();
    if (!empty($admin)) {          // could be empty if there is not identity provider
      db::build()
        ->update("tasks")
        ->set("owner_id", $admin->id)
        ->where("owner_id", "=", $user->id)
        ->execute();
      db::build()
        ->update("items")
        ->set("owner_id", $admin->id)
        ->where("owner_id", "=", $user->id)
        ->execute();
      db::build()
        ->update("logs")
        ->set("user_id", $admin->id)
        ->where("user_id", "=", $user->id)
        ->execute();
    }
  }

  static function identity_provider_changed($old_provider, $new_provider) {
    $admin = identity::admin_user();
    db::build()
      ->update("tasks")
      ->set("owner_id", $admin->id)
      ->execute();
    db::build()
      ->update("items")
      ->set("owner_id", $admin->id)
      ->execute();
    db::build()
      ->update("logs")
      ->set("user_id", $admin->id)
      ->execute();
    module::set_var("gallery", "email_from", $admin->email);
    module::set_var("gallery", "email_reply_to", $admin->email);
  }

  static function group_created($group) {
    access::add_group($group);
  }

  static function group_deleted($group) {
    access::delete_group($group);
  }

  static function item_created($item) {
    access::add_item($item);

    if ($item->is_photo() || $item->is_movie()) {
      // Build our thumbnail/resizes.
      try {
        graphics::generate($item);
      } catch (Exception $e) {
        log::error("graphics", t("Couldn't create a thumbnail or resize for %item_title",
                                 array("item_title" => $item->title)),
                   html::anchor($item->abs_url(), t("details")));
        Kohana_Log::add("error", $e->getMessage() . "\n" . $e->getTraceAsString());
      }

      // If the parent has no cover item, make this it.
      $parent = $item->parent();
      if (access::can("edit", $parent) && $parent->album_cover_item_id == null)  {
        item::make_album_cover($item);
      }
    }
  }

  static function item_deleted($item) {
    access::delete_item($item);

    // Find any other albums that had the deleted item as the album cover and null it out.
    // In some cases this may leave us with a missing album cover up in this item's parent
    // hierarchy, but in most cases it'll work out fine.
    foreach (ORM::factory("item")
             ->where("album_cover_item_id", "=", $item->id)
             ->find_all() as $parent) {
      item::remove_album_cover($parent);
    }

    $parent = $item->parent();
    if (!$parent->album_cover_item_id) {
      // Assume that we deleted the album cover
      if (batch::in_progress()) {
        // Remember that this parent is missing an album cover, for later.
        $batch_missing_album_cover = Session::instance()->get("batch_missing_album_cover", array());
        $batch_missing_album_cover[$parent->id] = 1;
        Session::instance()->set("batch_missing_album_cover", $batch_missing_album_cover);
      } else {
        // Choose the first viewable child as the new cover.
        if ($child = $parent->viewable()->children(1)->current()) {
          item::make_album_cover($child);
        }
      }
    }
  }

  static function item_updated_data_file($item) {
    graphics::generate($item);

    // Update any places where this is the album cover
    foreach (ORM::factory("item")
             ->where("album_cover_item_id", "=", $item->id)
             ->find_all() as $target) {
      $target->thumb_dirty = 1;
      $target->save();
      graphics::generate($target);
    }
  }

  static function batch_complete() {
    // Set the album covers for any items that where we probably deleted the album cover during
    // this batch.  The item may have been deleted, so don't count on it being around.  Choose the
    // first child as the new album cover.
    // NOTE: if the first child doesn't have an album cover, then this won't work.
    foreach (array_keys(Session::instance()->get("batch_missing_album_cover", array())) as $id) {
      $item = ORM::factory("item", $id);
      if ($item->loaded() && !$item->album_cover_item_id) {
        if ($child = $item->children(1)->current()) {
          item::make_album_cover($child);
        }
      }
    }
    Session::instance()->delete("batch_missing_album_cover");
  }

  static function item_moved($item, $old_parent) {
    if ($item->is_album()) {
      access::recalculate_album_permissions($item->parent());
    } else {
      access::recalculate_photo_permissions($item);
    }

    // If the new parent doesn't have an album cover, make this it.
    if (!$item->parent()->album_cover_item_id) {
      item::make_album_cover($item);
    }
  }

  static function user_login($user) {
    // If this user is an admin, check to see if there are any post-install tasks that we need
    // to run and take care of those now.
    if ($user->admin && module::get_var("gallery", "choose_default_tookit", null)) {
      graphics::choose_default_toolkit();
      module::clear_var("gallery", "choose_default_tookit");
    }
    Session::instance()->set("active_auth_timestamp", time());
    auth::clear_failed_attempts($user);
  }

  static function user_auth_failed($name) {
    auth::record_failed_attempt($name);
  }

  static function user_auth($user) {
    auth::clear_failed_attempts($user);
    Session::instance()->set("active_auth_timestamp", time());
  }

  static function item_index_data($item, $data) {
    $data[] = $item->description;
    $data[] = $item->name;
    $data[] = $item->title;
  }

  static function user_menu($menu, $theme) {
    if ($theme->page_subtype != "login") {
      $user = identity::active_user();
      if ($user->guest) {
        $menu->append(Menu::factory("dialog")
                      ->id("user_menu_login")
                      ->css_id("g-login-link")
                      ->url(url::site("login/ajax"))
                      ->label(t("Login")));
      } else {
        $csrf = access::csrf_token();
        $menu->append(Menu::factory("link")
                      ->id("user_menu_edit_profile")
                      ->css_id("g-user-profile-link")
                      ->view("login_current_user.html")
                      ->url(user_profile::url($user->id))
                      ->label($user->display_name()));

        if (Router::$controller == "admin") {
          $continue_url = url::abs_site("");
        } else if ($item = $theme->item()) {
          if (access::user_can(identity::guest(), "view", $theme->item)) {
            $continue_url = $item->abs_url();
          } else {
            $continue_url = item::root()->abs_url();
          }
        } else {
          $continue_url = url::abs_current();
        }

        $menu->append(Menu::factory("link")
                      ->id("user_menu_logout")
                      ->css_id("g-logout-link")
                      ->url(url::site("logout?csrf=$csrf&amp;continue_url=" . urlencode($continue_url)))
                      ->label(t("Logout")));
      }
    }
  }

  static function site_menu($menu, $theme, $item_css_selector) {
    if ($theme->page_subtype != "login") {
      $menu->append(Menu::factory("link")
                    ->id("home")
                    ->label(t("Home"))
                    ->url(item::root()->url()));


      $item = $theme->item();

      if (!empty($item)) {
        $can_edit = $item && access::can("edit", $item);
        $can_add = $item && access::can("add", $item);

        if ($can_add) {
          $menu->append($add_menu = Menu::factory("submenu")
                        ->id("add_menu")
                        ->label(t("Add")));
          $is_album_writable =
            is_writable($item->is_album() ? $item->file_path() : $item->parent()->file_path());
          if ($is_album_writable) {
            $add_menu->append(Menu::factory("dialog")
                              ->id("add_photos_item")
                              ->label(t("Add photos"))
                              ->url(url::site("uploader/index/$item->id")));
            if ($item->is_album()) {
              $add_menu->append(Menu::factory("dialog")
                                ->id("add_album_item")
                                ->label(t("Add an album"))
                                ->url(url::site("form/add/albums/$item->id?type=album")));
            }
          } else {
            message::warning(t("The album '%album_name' is not writable.",
                               array("album_name" => $item->title)));
          }
        }

        switch ($item->type) {
        case "album":
          $option_text = t("Album options");
          $edit_text = t("Edit album");
          $delete_text = t("Delete album");
          break;
        case "movie":
          $option_text = t("Movie options");
          $edit_text = t("Edit movie");
          $delete_text = t("Delete movie");
          break;
        default:
          $option_text = t("Photo options");
          $edit_text = t("Edit photo");
          $delete_text = t("Delete photo");
        }

        $menu->append($options_menu = Menu::factory("submenu")
                      ->id("options_menu")
                      ->label($option_text));
        if ($item && ($can_edit || $can_add)) {
          if ($can_edit) {
            $options_menu->append(Menu::factory("dialog")
                                  ->id("edit_item")
                                  ->label($edit_text)
                                  ->url(url::site("form/edit/{$item->type}s/$item->id?from_id={$item->id}")));
          }

          if ($item->is_album()) {
            if ($can_edit) {
              $options_menu->append(Menu::factory("dialog")
                                    ->id("edit_permissions")
                                    ->label(t("Edit permissions"))
                                    ->url(url::site("permissions/browse/$item->id")));
            }
          }
        }

        $csrf = access::csrf_token();
        $page_type = $theme->page_type();
        if ($can_edit && $item->is_photo() && graphics::can("rotate")) {
          $options_menu
            ->append(
              Menu::factory("ajax_link")
              ->id("rotate_ccw")
              ->label(t("Rotate 90° counter clockwise"))
              ->css_class("ui-icon-rotate-ccw")
              ->ajax_handler("function(data) { " .
                             "\$.gallery_replace_image(data, \$('$item_css_selector')) }")
              ->url(url::site("quick/rotate/$item->id/ccw?csrf=$csrf&amp;from_id={$item->id}&amp;page_type=$page_type")))
            ->append(
              Menu::factory("ajax_link")
              ->id("rotate_cw")
              ->label(t("Rotate 90° clockwise"))
              ->css_class("ui-icon-rotate-cw")
              ->ajax_handler("function(data) { " .
                             "\$.gallery_replace_image(data, \$('$item_css_selector')) }")
              ->url(url::site("quick/rotate/$item->id/cw?csrf=$csrf&amp;from_id={$item->id}&amp;page_type=$page_type")));
        }

        if ($item->id != item::root()->id) {
          $parent = $item->parent();
          if (access::can("edit", $parent)) {
            // We can't make this item the highlight if it's an album with no album cover, or if it's
            // already the album cover.
            if (($item->type == "album" && empty($item->album_cover_item_id)) ||
                ($item->type == "album" && $parent->album_cover_item_id == $item->album_cover_item_id) ||
                $parent->album_cover_item_id == $item->id) {
              $disabledState = "ui-state-disabled";
            } else {
              $disabledState = "";
            }

            if ($item->parent()->id != 1) {
              $options_menu
                ->append(
                  Menu::factory("ajax_link")
                  ->id("make_album_cover")
                  ->label(t("Choose as the album cover"))
                  ->css_class("ui-icon-star $disabledState")
                  ->ajax_handler("function(data) { window.location.reload() }")
                  ->url(url::site("quick/make_album_cover/$item->id?csrf=$csrf")));
            }
            $options_menu
              ->append(
                Menu::factory("dialog")
                ->id("delete")
                ->label($delete_text)
                ->css_class("ui-icon-trash")
                ->css_class("g-quick-delete")
                ->url(url::site("quick/form_delete/$item->id?csrf=$csrf&amp;from_id={$item->id}&amp;page_type=$page_type")));
          }
        }
      }

      if (identity::active_user()->admin) {
        $menu->append($admin_menu = Menu::factory("submenu")
                ->id("admin_menu")
                ->label(t("Admin")));
        module::event("admin_menu", $admin_menu, $theme);

        $settings_menu = $admin_menu->get("settings_menu");
        uasort($settings_menu->elements, array("Menu", "title_comparator"));
      }
    }
  }

  static function admin_menu($menu, $theme) {
    $menu
      ->append(Menu::factory("link")
               ->id("dashboard")
               ->label(t("Dashboard"))
               ->url(url::site("admin")))
      ->append(Menu::factory("submenu")
               ->id("settings_menu")
               ->label(t("Settings"))
               ->append(Menu::factory("link")
                        ->id("graphics_toolkits")
                        ->label(t("Graphics"))
                        ->url(url::site("admin/graphics")))
               ->append(Menu::factory("link")
                        ->id("languages")
                        ->label(t("Languages"))
                        ->url(url::site("admin/languages")))
               ->append(Menu::factory("link")
                        ->id("advanced")
                        ->label(t("Advanced"))
                        ->url(url::site("admin/advanced_settings"))))
      ->append(Menu::factory("link")
               ->id("modules")
               ->label(t("Modules"))
               ->url(url::site("admin/modules")))
      ->append(Menu::factory("submenu")
               ->id("content_menu")
               ->label(t("Content")))
      ->append(Menu::factory("submenu")
               ->id("appearance_menu")
               ->label(t("Appearance"))
               ->append(Menu::factory("link")
                        ->id("themes")
                        ->label(t("Theme choice"))
                        ->url(url::site("admin/themes")))
               ->append(Menu::factory("link")
                        ->id("theme_options")
                        ->label(t("Theme options"))
                        ->url(url::site("admin/theme_options")))
               ->append(Menu::factory("link")
                        ->id("sidebar")
                        ->label(t("Manage sidebar"))
                        ->url(url::site("admin/sidebar"))))
      ->append(Menu::factory("submenu")
               ->id("statistics_menu")
               ->label(t("Statistics")))
      ->append(Menu::factory("link")
               ->id("maintenance")
               ->label(t("Maintenance"))
               ->url(url::site("admin/maintenance")));
    return $menu;
  }

  static function context_menu($menu, $theme, $item, $thumb_css_selector) {
    $menu->append($options_menu = Menu::factory("submenu")
                  ->id("options_menu")
                  ->label(t("Options"))
                  ->css_class("ui-icon-carat-1-n"));

    $page_type = $theme->page_type();
    if (access::can("edit", $item)) {
      switch ($item->type) {
      case "movie":
        $edit_title = t("Edit this movie");
        $delete_title = t("Delete this movie");
        break;

      case "album":
        $edit_title = t("Edit this album");
        $delete_title = t("Delete this album");
        break;

      default:
        $edit_title = t("Edit this photo");
        $delete_title = t("Delete this photo");
        break;
      }
      $cover_title = t("Choose as the album cover");

      $csrf = access::csrf_token();

      $theme_item = $theme->item();
      $options_menu->append(Menu::factory("dialog")
                            ->id("edit")
                            ->label($edit_title)
                            ->css_class("ui-icon-pencil")
                            ->url(url::site("quick/form_edit/$item->id?from_id={$theme_item->id}")));

      if ($item->is_photo() && graphics::can("rotate")) {
        $options_menu
          ->append(
            Menu::factory("ajax_link")
            ->id("rotate_ccw")
            ->label(t("Rotate 90° counter clockwise"))
            ->css_class("ui-icon-rotate-ccw")
            ->ajax_handler("function(data) { " .
                           "\$.gallery_replace_image(data, \$('$thumb_css_selector')) }")
            ->url(url::site("quick/rotate/$item->id/ccw?csrf=$csrf&amp;from_id={$theme_item->id}&amp;page_type=$page_type")))
          ->append(
            Menu::factory("ajax_link")
            ->id("rotate_cw")
            ->label(t("Rotate 90° clockwise"))
            ->css_class("ui-icon-rotate-cw")
            ->ajax_handler("function(data) { " .
                           "\$.gallery_replace_image(data, \$('$thumb_css_selector')) }")
            ->url(url::site("quick/rotate/$item->id/cw?csrf=$csrf&amp;from_id={$theme_item->id}&amp;page_type=$page_type")));
      }

      $parent = $item->parent();
      if (access::can("edit", $parent)) {
        // We can't make this item the highlight if it's an album with no album cover, or if it's
        // already the album cover.
        if (($item->type == "album" && empty($item->album_cover_item_id)) ||
            ($item->type == "album" && $parent->album_cover_item_id == $item->album_cover_item_id) ||
            $parent->album_cover_item_id == $item->id) {
          $disabledState = "ui-state-disabled";
        } else {
          $disabledState = "";
        }
        if ($item->parent()->id != 1) {
          $options_menu
            ->append(Menu::factory("ajax_link")
                     ->id("make_album_cover")
                     ->label($cover_title)
                     ->css_class("ui-icon-star $disabledState")
                     ->ajax_handler("function(data) { window.location.reload() }")
                     ->url(url::site("quick/make_album_cover/$item->id?csrf=$csrf")));
        }
        $options_menu
          ->append(Menu::factory("dialog")
                   ->id("delete")
                   ->label($delete_title)
                   ->css_class("ui-icon-trash")
                   ->url(url::site("quick/form_delete/$item->id?csrf=$csrf&amp;" .
                                   "from_id={$theme_item->id}&amp;page_type=$page_type")));
      }

      if ($item->is_album()) {
        $options_menu
          ->append(Menu::factory("dialog")
                   ->id("add_item")
                   ->label(t("Add a photo"))
                   ->css_class("ui-icon-plus")
                   ->url(url::site("uploader/index/$item->id")))
          ->append(Menu::factory("dialog")
                   ->id("add_album")
                   ->label(t("Add an album"))
                   ->css_class("ui-icon-note")
                   ->url(url::site("form/add/albums/$item->id?type=album")))
          ->append(Menu::factory("dialog")
                   ->id("edit_permissions")
                   ->label(t("Edit permissions"))
                   ->css_class("ui-icon-key")
                   ->url(url::site("permissions/browse/$item->id")));
      }
    }
  }

  static function show_user_profile($data) {
    $v = new View("user_profile_info.html");

    $fields = array("name" => t("Name"), "locale" => t("Language Preference"),
                    "email" => t("Email"), "full_name" => t("Full name"), "url" => t("Web site"));
    if (!$data->user->guest) {
      $fields = array("name" => t("Name"), "full_name" => t("Full name"), "url" => t("Web site"));
    }
    $v->user_profile_data = array();
    foreach ($fields as $field => $label) {
      if (!empty($data->user->$field)) {
        $value = $data->user->$field;
        if ($field == "locale") {
          $value = locales::display_name($value);
        } else if ($field == "url") {
          $value = html::mark_clean(html::anchor(html::clean($data->user->$field)));
        }
        $v->user_profile_data[(string) $label] = $value;
      }
    }
    $data->content[] = (object) array("title" => t("User information"), "view" => $v);

  }

  static function user_updated($original_user, $updated_user) {
    // If the default from/reply-to email address is set to the install time placeholder value
    // of unknown@unknown.com then adopt the value from the first admin to set their own email
    // address so that we at least have a valid address for the Gallery.
    if ($updated_user->admin) {
      $email = module::get_var("gallery", "email_from", "");
      if ($email == "unknown@unknown.com") {
        module::set_var("gallery", "email_from", $updated_user->email);
        module::set_var("gallery", "email_reply_to", $updated_user->email);
      }
    }
  }
}