plugins/GNUsocialPhotos/classes/gnusocialphoto.php

   1 <?php
   2 /**
   3  * GNU Social
   4  * Copyright (C) 2010, Free Software Foundation, Inc.
   5  *
   6  * PHP version 5
   7  *
   8  * LICENCE:
   9  * This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Widget
  23  * @package   GNU Social
  24  * @author    Ian Denhardt <ian@zenhack.net>
  25  * @copyright 2010 Free Software Foundation, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  27  */
  28
  29 if (!defined('STATUSNET')) {
  30     exit(1);
  31 }
  32
  33 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
  34
  35 class GNUsocialPhoto extends Managed_DataObject
  36 {
  37     public $__table = 'GNUsocialPhoto';
  38     public $id;         // int(11)
  39     public $notice_id;  // int(11)
  40     public $album_id;   // int(11)
  41     public $uri;        // varchar(191)   not 255 because utf8mb4 takes more space
  42     public $thumb_uri;  // varchar(191)   not 255 because utf8mb4 takes more space
  43         public $title;      // varchar(191)   not 255 because utf8mb4 takes more space
  44         public $photo_description; // text
  45     public $created;           // datetime()   not_null
  46     public $modified;          // timestamp()   not_null default_CURRENT_TIMESTAMP
  47
  48 /*    function delete()
  49     {
  50         if(!unlink(INSTALLDIR . $this->thumb_uri)) {
  51             return false;
  52         }
  53         if(!unlink(INSTALLDIR . $this->path)) {
  54             return false;
  55         }
  56         return parent::delete();
  57     } */
  58
  59     public static function schemaDef()
  60     {
  61         return array(
  62             'fields' => array(
  63                 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'Unique ID for Photo'),
  64                 'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'Notice ID for the related notice'),
  65                 'album_id' => array('type' => 'int', 'not null' => true, 'description' => 'The parent album ID'),
  66                 'uri' => array('type' => 'varchar', 'not null' => true, 'length' => 191, 'description' => 'unique address for this photo'),
  67                 'thumb_uri' => array('type' => 'varchar', 'not null' => true, 'length' => 191, 'description' => 'unique address for this photo thumbnail'),
  68                 'title' => array('type' => 'varchar', 'not null' => true, 'length' => 191, 'description' => 'The Photo title'),
  69                 'photo_description' => array('type' => 'text', 'not null' => true, 'description' => 'A description for this photo'),
  70                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
  71                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  72             ),
  73             'primary key' => array('id'),
  74             'unique keys' => array(
  75                 'gnusocialphoto_id_key' => array('notice_id'),
  76                 'gnusocialphoto_uri_key' => array('uri'),
  77             ),
  78             'foreign keys' => array(
  79                 'gnusocialphoto_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
  80                 'gnusocialphoto_album_id_fkey' => array('GNUsocialPhotoAlbum', array('album_id' => 'id')),
  81             ),
  82             'indexes' => array(
  83                 'gnusocialphoto_title_idx' => array('title'),
  84             ),
  85         );
  86     }
  87
  88     static function saveNew($profile_id, $album_id, $thumb_uri, $uri, $source, $insert_now, $title = null, $photo_description = null)
  89     {
  90         $photo = new GNUsocialPhoto();
  91         $photo->thumb_uri = $thumb_uri;
  92         $photo->uri = $uri;
  93                 $photo->album_id = $album_id;
  94                 if(!empty($title)) $photo->title = $title;
  95                 if(!empty($photo_description)) $photo->photo_description = (string)$photo_description;
  96
  97         if($insert_now) {
  98             $notice = Notice::saveNew($profile_id, $uri, $source);
  99             $photo->notice_id = $notice->id;
 100             $photo_id = $photo->insert();
 101             if (!$photo_id) {
 102                 common_log_db_error($photo, 'INSERT', __FILE__);
 103                 throw new ServerException(_m('Problem Saving Photo.'));
 104             }
 105         } else {
 106             GNUsocialPhotoTemp::$tmp = $photo;
 107             Notice::saveNew($profile_id, $uri, $source);
 108         }
 109     }
 110
 111     function getPageLink()
 112     {
 113         return '/photo/' . $this->id;
 114     }
 115
 116     /*
 117      * TODO: -Sanitize input
 118      * @param int page_id The desired page of the gallery to show.
 119      * @param int album_id The id of the album to get photos from.
 120      * @param int gallery_size The number of thumbnails to show per page in the gallery.
 121      * @return array Array of GNUsocialPhotos for this gallery page.
 122      */
 123     static function getGalleryPage($page_id, $album_id, $gallery_size)
 124     {
 125                 $page_offset = ($page_id-1) * $gallery_size;
 126         $sql = 'SELECT * FROM GNUsocialPhoto WHERE album_id = ' . $album_id .
 127                ' ORDER BY notice_id LIMIT ' . $page_offset . ',' . $gallery_size;
 128         $photo = new GNUsocialPhoto();
 129         $photo->query($sql);
 130         $photos = array();
 131
 132         while ($photo->fetch()) {
 133             $photos[] = clone($photo);
 134         }
 135
 136         return $photos;
 137     }
 138 }