Skip to content

Commit

Permalink
Refactor album, category, place, person, photo
Browse files Browse the repository at this point in the history 
Made a start with refactoring the classes
album, category, place, person and photo

- Got rid of "passing around" a $user object for the currently logged on
user in several methods in favour of a static property in user.
- This also allowed me to merge lookup() and lookupForUser() back into
one lookup() method.
- Introduced an "Organizer" interface.
- Renamed several methods the the "new" camelCase coding standard
- Introduced some documentation
- Not yet fully tested
  • Loading branch information
@jeroenrnl
jeroenrnl committed Dec 30, 2012
1 parent 0796029 commit 52b30e7
Show file tree
Hide file tree
Showing 32 changed files with 491 additions and 448 deletions.
4 changes: 2 additions & 2 deletions php/UnitTests/createTestData/createTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,12 +209,12 @@ private static function importTestImages() {
if(isset($photoLocation[$id])) {
$photo->set("location_id",$photoLocation[$id]);
$photo->update();
$photo->lookup_location();
$photo->lookup();
}
if(isset($photographer[$id])) {
$photo->set("photographer_id",$photographer[$id]);
$photo->update();
$photo->lookup_photographer();
$photo->lookup();
}
if(is_array($photoAlbums[$id])) {
foreach($photoAlbums[$id] as $alb) {
Expand Down
4 changes: 2 additions & 2 deletions php/UnitTests/photoTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function testSetLocation($photo, $loc) {
$photo=new photo($photo);
$photo->set("location_id",$loc);
$photo->update();
$photo->lookup_location();
$photo->lookup();
$this->assertInstanceOf("place", $photo->location);
$this->assertEquals($photo->location->getId(), $loc);
}
Expand All @@ -47,7 +47,7 @@ public function testSetPhotographer($photo, $phg) {
$photo=new photo($photo);
$photo->set("photographer_id",$phg);
$photo->update();
$photo->lookup_photographer();
$photo->lookup();
$this->assertInstanceOf("person", $photo->photographer);
$this->assertEquals($photo->photographer->getId(), $phg);
}
Expand Down
147 changes: 69 additions & 78 deletions php/album.inc.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/

class album extends zophTreeTable {
class album extends zophTreeTable implements Organizer {

var $photoCount;
function album($id = 0) {
Expand All @@ -36,22 +36,16 @@ public function getId() {
}

public function lookup() {
$user=user::getCurrent();
$id = $this->get("album_id");
if(!is_numeric($id)) { die("album_id must be numeric"); }
if (!$id) { return; }

$sql =
"select * from " . DB_PREFIX . "albums " .
"where album_id = " . escape_string($id);
return $this->lookupFromSQL($sql);
}

public function lookupForUser(user $user) {
$id = $this->get("album_id");
if(!is_numeric($id)) { die("album_id must be numeric"); }
if (!$id) { return; }

if (!$user->is_admin()) {
if ($user->is_admin()) {
$sql =
"select * from " . DB_PREFIX . "albums " .
"where album_id = " . escape_string($id);
} else {
$sql =
"select a.* from " .
DB_PREFIX . "albums as a JOIN " .
Expand All @@ -62,10 +56,8 @@ public function lookupForUser(user $user) {
"where gp.album_id = '" . escape_string($id) . "'" .
" and gu.user_id = '" .
escape_string($user->get("user_id"))."'";
return $this->lookupFromSQL($sql);
} else {
return $this->lookup();
}
return $this->lookupFromSQL($sql);
}

function delete() {
Expand All @@ -88,7 +80,8 @@ function get_indented_name() {
return $indent . $this->getName();
}

function getChildren($user=null, $order=null) {
function getChildren($order=null) {
$user=user::getCurrent();
$order_fields="";
if($order && $order!="name") {
$order_fields=get_sql_for_order($order);
Expand All @@ -100,9 +93,20 @@ function getChildren($user=null, $order=null) {
$id = $this->get("album_id");
if (!$id) { return; }

if ($user && !$user->is_admin()) {
if ($user->is_admin()) {
$sql =
"SELECT a.*, album as name " .
"SELECT a.*, album as name " .
$order_fields . " FROM " .
DB_PREFIX . "albums as a LEFT JOIN " .
DB_PREFIX . "photo_albums as pa " .
"ON a.album_id=pa.album_id LEFT JOIN " .
DB_PREFIX . "photos as ph " .
"ON pa.photo_id=ph.photo_id " .
"WHERE parent_album_id=" . escape_string($id) .
" GROUP BY album_id" .
escape_string($order);
} else {
$sql = "SELECT a.*, album as name " .
$order_fields . " FROM " .
DB_PREFIX . "albums as a LEFT JOIN " .
DB_PREFIX . "photo_albums as pa " .
Expand All @@ -117,18 +121,6 @@ function getChildren($user=null, $order=null) {
" AND parent_album_id=" . escape_string($id) .
" GROUP BY album_id" .
escape_string($order);
} else {
$sql =
"SELECT a.*, album as name " .
$order_fields . " FROM " .
DB_PREFIX . "albums as a LEFT JOIN " .
DB_PREFIX . "photo_albums as pa " .
"ON a.album_id=pa.album_id LEFT JOIN " .
DB_PREFIX . "photos as ph " .
"ON pa.photo_id=ph.photo_id " .
"WHERE parent_album_id=" . escape_string($id) .
" GROUP BY album_id" .
escape_string($order);
}

$this->children=album::getRecordsFromQuery("album", $sql);
Expand All @@ -137,16 +129,14 @@ function getChildren($user=null, $order=null) {

/**
* Get details (statistics) about this album from db
* @param user Only show albums this user is allowed to see
* @return array Array with statistics
*/
public function getDetails(user $user=null) {
public function getDetails() {
$id = (int) $this->getId();
if(isset($user)) {
$user_id = (int) $user->getId();
}
$user=user::getCurrent();
$user_id = (int) $user->getId();

if ($user && !$user->is_admin()) {
if (!$user->is_admin()) {
$sql = "SELECT " .
"COUNT(ph.photo_id) AS count, " .
"MIN(DATE_FORMAT(CONCAT_WS(' ',ph.date,ph.time), GET_FORMAT(DATETIME, 'ISO'))) AS oldest, " .
Expand Down Expand Up @@ -194,25 +184,31 @@ public function getDetails(user $user=null) {

/**
* Turn the array from @see getDetails() into XML
* @param user Show only info about photos this user can see
* @param array Don't fetch details, but use the given array
*/
public function getDetailsXML(user $user, array $details=null) {
public function getDetailsXML(array $details=null) {
if(!isset($details)) {
$details=$this->getDetails($user);
$details=$this->getDetails();
}
$details["title"]=translate("In this album:", false);
return parent::getDetailsXML($user, $details);
return parent::getDetailsXML($details);
}

function getPhotoCount($user = null) {
public function getPhotoCount() {
$user=user::getCurrent();

if ($this->photoCount) { return $photoCount; }

$id = $this->get("album_id");

if ($user && !$user->is_admin()) {
if ($user->is_admin()) {
$sql =
"SELECT COUNT(*) FROM " .
DB_PREFIX . "photo_albums " .
"WHERE album_id = '" . escape_string($id) . "'";
} else {
$sql =
"select count(*) from " .
"SELECT COUNT(*) FROM " .
DB_PREFIX . "photo_albums AS pa JOIN " .
DB_PREFIX . "photos AS p ON " .
"pa.photo_id = p.photo_id JOIN " .
Expand All @@ -221,14 +217,8 @@ function getPhotoCount($user = null) {
DB_PREFIX . "groups_users AS gu ON " .
"gp.group_id = gu.group_id " .
"WHERE pa.album_id = " . escape_string($id) .
" and gu.user_id = '" . escape_string($user->get("user_id")) .
"' and gp.access_level >= p.level";
}
else {
$sql =
"select count(*) from " .
DB_PREFIX . "photo_albums " .
"where album_id = '" . escape_string($id) . "'";
" AND gu.user_id = '" . escape_string($user->get("user_id")) .
"' AND gp.access_level >= p.level";
}

return album::getCountFromQuery($sql);
Expand All @@ -238,7 +228,7 @@ function getTotalPhotoCount($user = null) {
// Without the lookup, parent_album_id is not available!
$this->lookup();
if ($this->get("parent_album_id")) {
$id_list = $this->get_branch_ids($user);
$id_list = $this->getBranchIds();
$id_constraint = "pa.album_id in ($id_list)";
}
else {
Expand Down Expand Up @@ -342,23 +332,32 @@ function xml_nodename() {
return "album";
}

function get_coverphoto($user,$autothumb=null,$children=null) {
function getCoverphoto($autothumb=null,$children=null) {
$user=user::getCurrent();
$coverphoto=null;
$cover=false;
if ($this->get("coverphoto")) {
$coverphoto=new photo($this->get("coverphoto"));
if($coverphoto->lookupForUser($user)) {
if($coverphoto->lookup()) {
$cover=TRUE;
}
}
if ($autothumb && !$cover) {
$order=get_autothumb_order($autothumb);
if($children) {
$album_where=" WHERE pa.album_id in (" . $this->get_branch_ids($user) .")";
$album_where=" WHERE pa.album_id in (" . $this->getBranchIds() .")";
} else {
$album_where=" WHERE pa.album_id =" .$this->get("album_id");
}
if ($user && !$user->is_admin()) {
if ($user->is_admin()) {
$sql =
"select distinct p.photo_id from " .
DB_PREFIX . "photos as p JOIN " .
DB_PREFIX . "photo_albums pa ON" .
" pa.photo_id = p.photo_id" .
$album_where .
" " . $order;
} else {
$sql=
"select distinct p.photo_id from " .
DB_PREFIX . "photos as p JOIN " .
Expand All @@ -374,14 +373,6 @@ function get_coverphoto($user,$autothumb=null,$children=null) {
" and pa.photo_id = p.photo_id " .
" and gp.access_level >= p.level " .
$order;
} else {
$sql =
"select distinct p.photo_id from " .
DB_PREFIX . "photos as p JOIN " .
DB_PREFIX . "photo_albums pa ON" .
" pa.photo_id = p.photo_id" .
$album_where .
" " . $order;
}
$coverphotos=photo::getRecordsFromQuery("photo", $sql);
$coverphoto=array_shift($coverphotos);
Expand All @@ -393,7 +384,7 @@ function get_coverphoto($user,$autothumb=null,$children=null) {
} else if (!$children) {
// No photos found in this album... let's look again, but now
// also in sub-albums...
return $this->get_coverphoto($user, $autothumb, true);
return $this->getCoverphoto($autothumb, true);
}
}
function is_root() {
Expand Down Expand Up @@ -433,9 +424,19 @@ public static function getRoot() {
/**
* Get Top N albums
*/
public static function getTopN(user $user=null) {
public static function getTopN() {
$user=user::getCurrent();

if ($user && !$user->is_admin()) {
if ($user->is_admin()) {
$sql =
"select al.*, count(*) as count from " .
DB_PREFIX . "albums as al, " .
DB_PREFIX . "photo_albums as pa " .
"where pa.album_id = al.album_id " .
"group by al.album_id " .
"order by count desc, al.album " .
"limit 0, " . escape_string($user->prefs->get("reports_top_n"));
} else {
$sql =
"SELECT al.*, count(distinct ph.photo_id) AS count FROM " .
DB_PREFIX . "albums AS al JOIN " .
Expand All @@ -453,16 +454,6 @@ public static function getTopN(user $user=null) {
"ORDER BY count desc, al.album " .
"LIMIT 0, " . escape_string($user->prefs->get("reports_top_n"));
}
else {
$sql =
"select al.*, count(*) as count from " .
DB_PREFIX . "albums as al, " .
DB_PREFIX . "photo_albums as pa " .
"where pa.album_id = al.album_id " .
"group by al.album_id " .
"order by count desc, al.album " .
"limit 0, " . escape_string($user->prefs->get("reports_top_n"));
}

return parent::getTopNfromSQL("album", $sql);

Expand Down
13 changes: 6 additions & 7 deletions php/albums.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@
else {
$album = new album($parent_album_id);
}
$album->lookupForUser($user);
$album->lookup();
$obj=&$album;
$ancestors = $album->get_ancestors();
$order = $user->prefs->get("child_sortorder");
$children = $album->getChildren($user, $order);
$totalPhotoCount = $album->getTotalPhotoCount($user);
$photoCount = $album->getPhotoCount($user);
$children = $album->getChildren($order);
$totalPhotoCount = $album->getTotalPhotoCount();
$photoCount = $album->getPhotoCount();

$title = $album->get("parent_album_id") ? $album->get("album") : translate("Albums");

Expand Down Expand Up @@ -101,7 +101,7 @@
<p>
<?php
}
echo $album->get_coverphoto($user);
echo $album->getCoverphoto();
?>
</p>
<?php
Expand All @@ -124,7 +124,7 @@
if ($totalPhotoCount > $photoCount && $children) {
?>
<span class="actionlink">
<a href="photos.php?album_id=<?php echo $album->get_branch_ids($user) . $sort ?>"><?php echo translate("view photos") ?></a>
<a href="photos.php?album_id=<?php echo $album->getBranchIds() . $sort ?>"><?php echo translate("view photos") ?></a>
</span>
<?php
$fragment .= " " . translate("or its children");
Expand Down Expand Up @@ -160,7 +160,6 @@
$tpl=new template("view_" . $_view, array(
"id" => $_view . "view",
"items" => $children,
"user" => $user,
"autothumb" => $_autothumb,
"topnode" => true,
"links" => array(
Expand Down
Loading

0 comments on commit 52b30e7

Please sign in to comment.