source: extensions/UserCollections/include/UserCollection.class.php @ 29354

<?php
defined('USER_COLLEC_PATH') or die('Hacking attempt!');

class UserCollection
{
  private $data;
  private $images;

  /**
   * __construct
   * @throws Exception
   *
   * @param int|string $col_id or 'new'
   * @param string $name
   * @param string $comment
   * @param int $user_id
   */
  function __construct($col_id, $name=null, $comment=null, $user_id=null)
  {
    global $user;

    if (empty($user_id))
    {
      $user_id = $user['id'];
    }

    $this->data = array(
      'id' => 0,
      'user_id' => $user_id,
      'name' => null,
      'date_creation' => '0000-00-00 00:00:00',
      'comment' => null,
      'nb_images' => 0,
      );
    $this->images = array();

    // load specific collection
    if (preg_match('#^[0-9]+$#', $col_id))
    {
      $query = '
SELECT *
  FROM '.COLLECTIONS_TABLE.'
  WHERE id = '.$col_id.'
;';
      $result = pwg_query($query);

      if (pwg_db_num_rows($result))
      {
        $this->data = array_merge(
          $this->data,
          pwg_db_fetch_assoc($result)
          );

        // make sure all pictures of the collection exist
        $query = '
DELETE FROM '.COLLECTION_IMAGES_TABLE.'
  WHERE image_id NOT IN (
    SELECT id FROM '.IMAGES_TABLE.'
    )
;';
        pwg_query($query);

        // select images of the collection
        $query = '
SELECT image_id
  FROM '.COLLECTION_IMAGES_TABLE.'
  WHERE col_id = '.$this->data['id'].'
;';
        $this->images = array_from_query($query, 'image_id');

        $this->updateParam('nb_images', count($this->images));
      }
      else
      {
        throw new Exception(l10n('Invalid collection'));
      }
    }
    // create a new collection
    else if ($col_id == 'new')
    {
      $this->data['name'] = $name;
      $this->data['comment'] = $comment;

      $query = '
INSERT INTO '.COLLECTIONS_TABLE.'(
    user_id,
    name,
    date_creation,
    comment
  )
  VALUES(
    '.$this->data['user_id'].',
    "'.$this->data['name'].'",
    NOW(),
    "'.$this->data['comment'].'"
  )
;';
      pwg_query($query);
      $this->data['id'] = pwg_db_insert_id();

      $date = pwg_query('SELECT NOW();');
      list($this->data['date_creation']) = pwg_db_fetch_row($date);
    }
    else
    {
      trigger_error('UserCollection::__construct, invalid input parameter', E_USER_ERROR);
    }
  }

  /**
   * Check if current user is owner of the collection or admin
   * @throws Exception
   */
  function checkUser()
  {
    global $user;

    if (!is_admin() && $user['id'] != $this->data['user_id'])
    {
      throw new Exception('Forbidden', 403);
    }
  }

  /**
   * updateParam
   *
   * @param string $name
   * @param mixed $value
   */
  function updateParam($name, $value)
  {
    if ($value != $this->data[$name])
    {
      $this->data[$name] = $value;
      pwg_query('UPDATE '.COLLECTIONS_TABLE.' SET '.$name.' = "'.pwg_db_real_escape_string($value).'" WHERE id = '.$this->data['id'].';');
    }
  }

  /**
   * getParam
   *
   * @param string $name
   * @return mixed
   */
  function getParam($name)
  {
    return $this->data[$name];
  }

  /**
   * getImages
   *
   * @return int[]
   */
  function getImages()
  {
    return $this->images;
  }

  /**
   * Check if an image is in the collection.
   *
   * @param int $image_id
   * @return bool
   */
  function isInSet($image_id)
  {
    return in_array($image_id, $this->images);
  }

  /**
   * removeImages
   *
   * @param int|int[] $image_ids
   */
  function removeImages($image_ids)
  {
    if (empty($image_ids)) return;
    if (!is_array($image_ids)) $image_ids = array($image_ids);

    $this->images = array_diff($this->images, $image_ids);

    $query = '
DELETE FROM '.COLLECTION_IMAGES_TABLE.'
  WHERE
    col_id = '.$this->data['id'].'
    AND image_id IN('.implode(',', $image_ids).')
;';
    pwg_query($query);

    $this->updateParam('nb_images', count($this->images));
  }

  /**
   * addImages
   *
   * @param int|int[] $image_ids
   */
  function addImages($image_ids)
  {
    if (empty($image_ids)) return;
    if (!is_array($image_ids)) $image_ids = array($image_ids);

    $image_ids = array_unique($image_ids);
    $inserts = array();

    foreach ($image_ids as $image_id)
    {
      if ($this->isInSet($image_id)) continue;

      $this->images[] = $image_id;
      $inserts[] = array(
        'col_id' => $this->data['id'],
        'image_id' => $image_id,
        );
    }

    mass_inserts(
      COLLECTION_IMAGES_TABLE,
      array('col_id', 'image_id'),
      $inserts
      );

    $query = '
UPDATE '.COLLECTION_IMAGES_TABLE.'
  SET add_date = NOW()
  WHERE
    col_id = '.$this->data['id'].'
    AND image_id IN ('.implode(',', $image_ids).')
    AND add_date IS NULL
';
    pwg_query($query);

    $this->updateParam('nb_images', count($this->images));
  }

  /**
   * toggleImage
   *
   * @param int $image_id
   */
  function toggleImage($image_id)
  {
    if ($this->isInSet($image_id))
    {
      $this->removeImages(array($image_id));
    }
    else
    {
      $this->addImages(array($image_id));
    }
  }

  /**
   * clearImages
   */
  function clearImages()
  {
    $this->images = array();
    $this->updateParam('nb_images', 0);

    $query = '
DELETE FROM '.COLLECTION_IMAGES_TABLE.'
  WHERE col_id = '.$this->data['id'].'
;';
    pwg_query($query);
  }

  /**
   * getCollectionInfo
   *
   * @return array
   */
  function getCollectionInfo()
  {
    $set = array(
      'ID' => $this->data['id'],
      'NAME' => $this->data['name'],
      'COMMENT' => $this->data['comment'],
      'NB_IMAGES' => $this->data['nb_images'],
      'DATE_CREATION' => $this->data['date_creation'],
      );

    return $set;
  }

  /**
   * Returns share links
   *
   * @return array
   */
  function getShares()
  {
    $query = '
SELECT * FROM '.COLLECTION_SHARES_TABLE.'
  WHERE col_id = '.$this->data['id'].'
  ORDER BY add_date DESC
;';
    $result = pwg_query($query);

    $shares = array();
    while ($row = pwg_db_fetch_assoc($result))
    {
      $row['expired'] = false;

      $row['params'] = unserialize($row['params']);
      if (!empty($row['params']['deadline']))
      {
        $row['expired'] = strtotime($row['params']['deadline']) < time();
        $row['params']['deadline_readable'] = format_date($row['params']['deadline'], true, false);
      }

      $row['url'] = USER_COLLEC_PUBLIC . 'view/' . $row['share_key'];
      $row['u_delete'] = USER_COLLEC_PUBLIC . 'edit/' . $this->data['id'] . '&amp;delete_share=' . $row['id'];
      $row['add_date_readable'] = format_date($row['add_date'], true, false);

      $shares[] = $row;
    }

    return $shares;
  }

  /**
   * Delete a share
   *
   * @param int $id
   * @return bool
   */
  function deleteShare($id)
  {
    $query = '
DELETE FROM '.COLLECTION_SHARES_TABLE.'
  WHERE id = "'.pwg_db_real_escape_string($id).'"
  AND col_id = '.$this->data['id'].'
;';
    pwg_query($query);

    return pwg_db_changes() != 0;
  }

  /**
   * Add a share link
   *
   * @param array &$share
   *          - share_key (will be slugified)
   *          - password (optional)
   *          - deadline (optional)
   * @param bool $abord_on_duplicate
   * @return array|string errors or full share link
   */
  function addShare(&$share, $abord_on_duplicate=true)
  {
    global $conf, $page;

    $errors = array();

    $share = array_map('stripslashes', $share);

    // check key
    if (empty($share['share_key']) || strlen($share['share_key']) < 8)
    {
      $errors[] = l10n('The key must be at least 8 characters long');
    }
    else
    {
      $share['share_key'] = str2url($share['share_key']);
      $share_key = $this->data['id'].'-'.$share['share_key'];

      $query = '
SELECT id FROM '.COLLECTION_SHARES_TABLE.'
  WHERE col_id = '.$this->data['id'].'
  AND share_key = "'.$share_key.'"
;';
      $result = pwg_query($query);
      if (pwg_db_num_rows($result))
      {
        if ($abord_on_duplicate)
        {
          $errors[] = l10n('This key is already used');
        }
        else
        {
          return USER_COLLEC_PUBLIC . 'view/' . $share_key;
        }
      }
    }

    // filter date
    if (!empty($share['deadline']))
    {
      $share['deadline'] = transform_date($share['deadline'], 'Y-m-d H:i', 'Y-m-d H:i');
    }

    // hash password
    if (!empty($share['password']))
    {
      $share['password'] = sha1($conf['secret_key'].$share['password'].$share_key);
    }

    if (empty($errors))
    {
      $params = serialize(array(
        'password' => @$share['password'],
        'deadline' => @$share['deadline'],
        ));

      $query = '
INSERT INTO '.COLLECTION_SHARES_TABLE.'(
    col_id,
    share_key,
    params,
    add_date
  )
  VALUES(
    '.$this->data['id'].',
    "'.$share_key.'",
    "'.pwg_db_real_escape_string($params).'",
    "'.date('Y-m-d H:i:s').'"
  )
;';
      pwg_query($query);

      return USER_COLLEC_PUBLIC . 'view/' . $share_key;
    }

    return $errors;
  }

  /**
   * Send the collection by email
   *
   * @param array $comm
   *          - sender_name
   *          - sender_email
   *          - recipient_email
   *          - recipient_name
   *          - nb_images
   *          - message
   * @return array|true array errors or true
   */
  function sendEmail($comm)
  {
    global $conf, $user;

    $errors = array();

    $comm = array_map('stripslashes', $comm);

    $comment_action = 'validate';
    $for_admin = $comm['to'] == 'admin';

    // check author
    if (empty($comm['sender_name']))
    {
      $errors[] = l10n('Please enter your name');
      $comment_action = 'reject';
    }
    if (!$for_admin && empty($comm['recipient_name']))
    {
      $errors[] = l10n('Please enter the recipient name');
      $comment_action = 'reject';
    }

    // check email
    if (empty($comm['sender_email']))
    {
      $errors[] = l10n('Please enter your e-mail');
      $comment_action = 'reject';
    }
    else if (!empty($comm['sender_email']) and !email_check_format($comm['sender_email']))
    {
      $errors[] = l10n('mail address must be like xxx@yyy.eee (example : jack@altern.org)');
      $comment_action = 'reject';
    }
    if (!$for_admin)
    {
      if (empty($comm['recipient_email']))
      {
        $errors[] = l10n('Please enter the recipient e-mail');
        $comment_action = 'reject';
      }
      else if (!empty($comm['recipient_email']) and !email_check_format($comm['recipient_email']))
      {
        $errors[] = l10n('mail address must be like xxx@yyy.eee (example : jack@altern.org)');
        $comment_action = 'reject';
      }
    }

    // check content
    if (!empty($comm['message']))
    {
      $comm['message'] = nl2br($comm['message']);
    }

    include_once(PHPWG_ROOT_PATH.'include/functions_mail.inc.php');

    if ($comment_action == 'validate')
    {
      if (!$for_admin)
      {
        // switch to guest user for get_sql_condition_FandF
        $user_save = $user;
        $user = build_user($conf['guest_id'], true);
      }

      // get pictures
      $query = '
SELECT
    id, file, name, path
  FROM '.IMAGES_TABLE.' AS i
    JOIN '.IMAGE_CATEGORY_TABLE.' AS ci ON ci.image_id = i.id
  WHERE id IN ('. implode(',', $this->images) .')
    '.get_sql_condition_FandF(
        array(
          'forbidden_categories' => 'category_id',
          'forbidden_images' => 'id'
          ),
        'AND'
        ).'
  GROUP BY i.id
  ORDER BY '. DB_RANDOM_FUNCTION .'()
  LIMIT '. $comm['nb_images'] .'
;';
      $pictures = hash_from_query($query, 'id');

      if (!$for_admin)
      {
        // switch back to current user
        $user = $user_save;
        unset($user_save);
      }

      // pictures infos
      set_make_full_url();
      $thumbnails = array();

      foreach ($pictures as $row)
      {
        $name = render_element_name($row);

        $thumbnails[] = array(
          'TN_ALT' => htmlspecialchars(strip_tags($name)),
          'NAME' =>   $name,
          'URL' =>    make_picture_url(array('image_id' => $row['id'])),
          'THUMB' =>  DerivativeImage::url(IMG_SQUARE, $row),
          );
      }

      unset_make_full_url();

      if ($for_admin)
      {
        $col_url = USER_COLLEC_PUBLIC.'edit/'.$this->data['id'];
      }
      else
      {
        $share_key = array('share_key'=>'mail-' . substr(sha1($this->data['id'].$conf['secret_key']), 0, 11));
        $col_url = $this->addShare($share_key, false);
      }

      $mail_config = array(
        'subject' => '['.$conf['gallery_title'].'] '.l10n('A photo collection by %s', $comm['sender_name']),
        'mail_title' => $this->getParam('name'),
        'mail_subtitle' => l10n('by %s', $comm['sender_name']),
        'content_format' => 'text/html',
        'from' => array(
          'name' => $comm['sender_name'],
          'email' => $comm['sender_email'],
          )
        );
      $mail_tpl = array(
        'filename' => 'mail',
        'dirname' => realpath(USER_COLLEC_PATH . 'template'),
        'assign' => array(
          'COL_URL' => $col_url,
          'PARAMS' => $comm,
          'derivative_params' => ImageStdParams::get_by_type(IMG_SQUARE),
          'THUMBNAILS' => $thumbnails,
          )
        );
      
      if ($for_admin)
      {
        $result = pwg_mail_admins($mail_config, $mail_tpl);
      }
      else
      {
        $result = pwg_mail(
          array(
            'name' => $comm['recipient_name'],
            'email' => $comm['recipient_email'],
            ),
          $mail_config,
          $mail_tpl
          );
      }

      if ($result == false)
      {
        $errors[] = l10n('Error while sending e-mail');
      }
      else
      {
        return true;
      }
    }

    return $errors;
  }

  /**
   * Generate a listing of the collection
   *
   * @param string[] $fields
   * @return string
   */
  function serialize($fields)
  {
    $fields = array_intersect($fields, array('id','file','name','url','path','date_creation','collection_add_date','filesize','width','height'));

    $content = null;

    // get images infos
    $query = '
SELECT
    id,
    file,
    name,
    path,
    date_creation,
    filesize,
    width,
    height,
    add_date AS collection_add_date
  FROM '.IMAGES_TABLE.'
    JOIN '.COLLECTION_IMAGES_TABLE.' ON id = image_id
  WHERE col_id = '.$this->data['id'].'
  ORDER BY id
;';
    $pictures = hash_from_query($query, 'id');

    if (count($pictures))
    {
      // generate csv
      set_make_full_url();
      $root_url = get_root_url();

      $fp = fopen('php://temp', 'r+');
      fputcsv($fp, $fields);

      foreach ($pictures as $row)
      {
        $element = array();
        foreach ($fields as $field)
        {
          switch ($field)
          {
          case 'name':
            $element[] = render_element_name($row);
            break;
          case 'url':
            $element[] = make_picture_url(array('image_id'=>$row['id'], 'image_file'=>$row['file']));
            break;
          case 'path':
            $element[] = $root_url.ltrim($row['path'], './');
            break;
          default:
            $element[] = $row[$field];
            break;
          }
        }
        if (!empty($element))
        {
          fputcsv($fp, $element);
        }
      }

      rewind($fp);
      $content = stream_get_contents($fp);
      fclose($fp);

      unset_make_full_url();
    }

    return $content;
  }

  /**
   * Delete the collection
   */
  function delete()
  {
    $this->clearImages();
    pwg_query('DELETE FROM '.COLLECTIONS_TABLE.' WHERE id = '.$this->data['id'].';');
  }
}