subalbum.cpp

Go to the documentation of this file.

//==============================================
//  copyright            : (C) 2003 by Will Stokes
//==============================================
//  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.         
//
//  As a special exception, Will Stokes gives permission to 
//  link this program with Qt non-commercial edition, and 
//  distribute the resulting executable, without including the 
//  source code for the Qt non-commercial edition in the 
//  source distribution. 
//==============================================

//Systemwide includes
#include <qimage.h>
#include <qpixmap.h>
#include <qstring.h>
#include <qtextstream.h>
#include <qdom.h>
#include <fstream>
#include <qdir.h>
#include <qregexp.h>
#include <qapplication.h>

//Projectwide includes
#include "album.h"
#include "subalbum.h"
#include "photo.h"
#include "imageTools.h"
#include "xmlTools.h"
#include "md5.h"
#include "../gui/photoWidget.h"
#include "../gui/statusWidget.h"
#include "../config.h"

//==============================================
Subalbum::Subalbum(Album* albm, int number)
{
  //set subalbum number
  this->number = number;

  //by default no photos in subalbum
  numPhotos = 0;
  loadedPhotos = 0;
  
  //set strings to default values
  name = "";
  description ="";

  //set default rep images
  smallRepresentativeImage = new QPixmap( QString(IMAGE_PATH)+"notSpecified.png" );
  mediumRepresentativeImage = new QPixmap( QString(IMAGE_PATH)+"subalbum.png" );
  largeRepresentativeImage = NULL;

  //no photos by default
  firstPhoto = NULL;
  lastPhoto = NULL;
  
  //next pointer null by default
  nextSubalbum = NULL;
  
  //set album pointer
  this->albm = albm;
}
//==============================================
Subalbum::~Subalbum()
{
  //delete representative images
  delete smallRepresentativeImage;
  delete mediumRepresentativeImage;
  delete largeRepresentativeImage;
  
  //delete all photos
  Photo* current = firstPhoto;
  Photo* temp;
  while(current != NULL)
  {
    temp = current->getNext();
    delete current;
    current = temp;
  }
} 
//==============================================
void Subalbum::setName(QString val)
{
  if(name != val)
  {
    name = val;
    albm->setModified();
  }
}
//==============================================
QString Subalbum::getName()
{
  return QString(name);
}
//==============================================
void Subalbum::setDescription(QString val)
{
  if(description != val)
  {
    description = val;
    albm->setModified();
  }
}
//==============================================
QString Subalbum::getDescription()
{
  return QString(description);
}
//==============================================
//gets a sized representative image  
QPixmap* Subalbum::getRepresentativeImage(int size)
{
  if(size == SMALL)
    return smallRepresentativeImage;
  if(size == MEDIUM)
    return mediumRepresentativeImage;
  if(size == LARGE)
    return largeRepresentativeImage;
  else
    return NULL;
}
//==============================================
//sets a sized representative iamge
void Subalbum::setRepresentativeImages(QImage* rawThumbnail)
{
  //---------------------------------------------------------    
  //delete old representative images
  delete smallRepresentativeImage;
  delete mediumRepresentativeImage;
  delete largeRepresentativeImage;
  //---------------------------------------------------------    
  //compute various representative image sizes
  int smallRepWidth = 0;
  int smallRepHeight = 0;
  int mediumRepWidth = 0;
  int mediumRepHeight = 0;  
  resizeImage( rawThumbnail->width(), rawThumbnail->height(),
               131, 98,
               mediumRepWidth, mediumRepHeight);
  resizeImage( rawThumbnail->width(), rawThumbnail->height(),
               107, 80,
               smallRepWidth, smallRepHeight);
  //---------------------------------------------------------    
  //create various representative images
  //---------------------------------------------------------    
  //copy and scale small version
  QImage thumbnailSmall = rawThumbnail->smoothScale( smallRepWidth, smallRepHeight );
  smallRepresentativeImage = new QPixmap( smallRepWidth, smallRepHeight );
  smallRepresentativeImage->convertFromImage( thumbnailSmall );  
  
  //copy and scale medium version
  QImage thumbnailMedium = rawThumbnail->smoothScale( mediumRepWidth, mediumRepHeight );
  QImage* centeredThumbnailMedium = new QImage(131, 98, thumbnailMedium.depth());
  centeredThumbnailMedium->setAlphaBuffer(true);
 
  int xDiff = 131 - mediumRepWidth;
  int yDiff = 98  - mediumRepHeight;
  
  //set all pixels to white
  int x, y;
  for(x=0; x< 131; x++)
  {
    for(y=0; y<98; y++)
    {
      centeredThumbnailMedium->setPixel(x, y, QColor(255, 255, 255).rgb()); 
    }
  }
  
  int x2 = 0;
  for(x= xDiff/2; x < (xDiff/2) + mediumRepWidth; x++)
  {
    int y2 = 0;
    for(y= yDiff/2; y < (yDiff/2) + mediumRepHeight; y++)
    {
      centeredThumbnailMedium->setPixel(x, y, thumbnailMedium.pixel(x2, y2));
      y2++;
    }
    x2++;
  }
  
  mediumRepresentativeImage = new QPixmap( centeredThumbnailMedium->width(), centeredThumbnailMedium->height() );
  mediumRepresentativeImage->convertFromImage( *centeredThumbnailMedium );
  delete centeredThumbnailMedium;
  //copy large version 
  largeRepresentativeImage = new QPixmap(*rawThumbnail);
  //---------------------------------------------------------    
    
  //set modified
  albm->setModified();
}
//==============================================
void Subalbum::addPhoto(Photo* newPhoto)
{
  //increase counter
  numPhotos++;
  
  //set it's next pointer to null
  newPhoto->setNext(NULL);

  //if this is the only photo, set first and last 
  //pointers to this photo.
  if(firstPhoto == NULL)
  {
    firstPhoto = newPhoto;
    lastPhoto = newPhoto;
  }
  //else append to end of list
  else
  {
    lastPhoto->setNext(newPhoto);
    lastPhoto = newPhoto;
  }
    
  //set modified
  albm->setModified();
}
//==============================================
bool Subalbum::addPhoto(QString fileName, bool replaceDescription, Photo* newPhoto)
{
  numPhotos++;
  
  //create new photo if necessary
  if(newPhoto == NULL)
    newPhoto = new Photo(this, numPhotos);
    
  //replace description with filename if instructed
  //(aka /home/bob/happy.jpg -> happy)
  if(replaceDescription) 
  {
    QString desc(fileName);  
    desc = desc.section( QRegExp("/"), -1);
    desc.truncate(desc.length() - 4);
    newPhoto->setDescription( desc );
  }
    
  //attempt to set image
  if(!newPhoto->setImage(fileName))
  {
    delete newPhoto;
    return false;
  }
  
  //if this is the only photo, set first and last 
  //pointers to this photo.
  if(firstPhoto == NULL)
  {
    firstPhoto = newPhoto;
    lastPhoto = newPhoto;
  }
  //else append to end of list
  else
  {
    lastPhoto->setNext(newPhoto);
    lastPhoto = newPhoto;
  }
  
  //copy image file over
  QString saveName = QDir::homeDirPath() + QString("/.albumShaper/tmp/%1_%2")
                                .arg(number)
                                .arg(numPhotos);
  
  newPhoto->getImage(IMAGE)->save( saveName + ".jpg", "JPEG", 100);
  newPhoto->getImage(SLIDESHOW)->save( saveName + "_slideshow.jpg", "JPEG", 100);
  
  newPhoto->setImageFilename(saveName + ".jpg");
  newPhoto->setSlideshowFilename(saveName + "_slideshow.jpg");
  
  //deallocate full image and slideshow versions to conserve memory
  newPhoto->deallocateLargeImages();
    
  //set modified
  albm->setModified();
  
  return true;
}
//==============================================
bool Subalbum::lazyAddPhoto(QString imageName, 
                                          QString slideshowName, 
                                          QString thumbnailName, 
                                          Photo* newPhoto)
{
  numPhotos++;
  
  //attempt to set image
  if(!newPhoto->setImage(imageName, slideshowName, thumbnailName))
  {
    delete newPhoto;
    return false;
  }
  
  //if this is the only photo, set first and last 
  //pointers to this photo.
  if(firstPhoto == NULL)
  {
    firstPhoto = newPhoto;
    lastPhoto = newPhoto;
  }
  //else append to end of list
  else
  {
    lastPhoto->setNext(newPhoto);
    lastPhoto = newPhoto;
  }
    
  //set modified
  albm->setModified();
  
  return true;
}
//==============================================
void Subalbum::removePhoto(Photo* val)
{ 
  //walk through list of photos and find specified photo
  Photo* current = firstPhoto;
  Photo* prev = NULL;
  while(current != val && current->getNext() != NULL)
  {
    prev = current;
    current = current->getNext();
  }

  if(current == val)
  {
    //update prev next pointer
    if(prev != NULL)
      prev->setNext(current->getNext());
    
    //update first and last pointers if necessary
    if(current == firstPhoto)
      firstPhoto = current->getNext();
    if(current == lastPhoto)
      lastPhoto = prev;

    //free Photo
    delete current;
    current = NULL;
    numPhotos--;
  }
    
  //set modified
  albm->setModified();
}
//==============================================
Subalbum* Subalbum::getNext()
{
  return nextSubalbum;
}
//==============================================
void Subalbum::setNext(Subalbum* val)
{
  nextSubalbum = val;
    
  //set modified
  albm->setModified();
}
//==============================================
void Subalbum::exportToXML(QTextStream& stream)
{
  //write subalbum information
  stream << "  <subalbum>\n";
  stream << "    <name>" << fixXMLString(name) << "</name>\n";
  stream << "    <description>" << fixXMLString(description) << "</description>\n";
  
  //if subalbum has a represenatative image save it's path
   if(getRepresentativeImage(LARGE) != NULL )
   {
     stream << "    <thumb path=\"img/" << number << "_thumb.jpg\"/>\n"; 
   }  
  
  //write photos
  Photo* current = firstPhoto;
  while(current != NULL)
  {
    current->exportToXML(stream);
    current = current->getNext();
  }  
  
  //close subalbum
  stream << "  </subalbum>\n";

}
//==============================================
Photo* Subalbum::getFirst()
{
  return firstPhoto;
}
//==============================================
Photo* Subalbum::getLast()
{
  return lastPhoto;
}
//==============================================
void Subalbum::importFromDisk(QDomNode* root, 
                                            int subalbumNum, 
                                            StatusWidget* status, 
                                            QString dirName)
{
  //if representative image exists load
  QString repName = QString(dirName + "/img/%1_thumb.jpg").arg(subalbumNum);
  QImage repImage(repName);
  if(!repImage.isNull())
  {
    setRepresentativeImages(&repImage);  
  }  
  
  QDomNode node = root->firstChild();
  QDomText val;  
  int photoNum = 0;
  while( !node.isNull() )
  {
    //------------------------------------------------------------
    //subalbum name
    if( node.isElement() && node.nodeName() == "name" )
    { 
      val = node.firstChild().toText();
      if(!val.isNull())
        name = val.nodeValue();
    }
    //------------------------------------------------------------
    //subalbum description
    else if( node.isElement() && node.nodeName() == "description" )
    { 
      val = node.firstChild().toText();
      if(!val.isNull())
        description = val.nodeValue();
    }
    //------------------------------------------------------------
    //photo
    else if( node.isElement() && node.nodeName() == "photo" )
    { 
      //increase counter
      photoNum++;
      
      //create new photo object
      QString imageName = QString(dirName + "img/%1/%2.jpg").arg(subalbumNum).arg(photoNum);
      QString slideshowName = QString(dirName + "img/%1/%2_slideshow.jpg").arg(subalbumNum).arg(photoNum);
      QString thumbName = QString(dirName + "img/%1/%2_thumb.jpg").arg(subalbumNum).arg(photoNum);
      Photo* newPhoto = new Photo(this, photoNum);

      //load photo information from disk
      QDateTime* modificationTimes = newPhoto->importFromDisk( &node );      

      //first check to see if modifications times have changed
      bool lazyLoad = true; //assume no modifications     
      QFileInfo info[3];
      info[0].setFile( imageName );
      info[1].setFile( slideshowName );
      info[2].setFile( thumbName );
      if(modificationTimes[0] != info[0].lastModified() ||
         modificationTimes[1] != info[1].lastModified() ||
         modificationTimes[2] != info[2].lastModified())
         lazyLoad = false;

      //if no changes have occured do lazy load - don't 
      //bother scaling down thumbnail and slideshow images
      //from original image
      std::ifstream imageFile( imageName );      
      std::ifstream slideshowFile( slideshowName );      
      std::ifstream thumbnailFile( thumbName );
      
      if( lazyLoad ||
          (
            imageFile.is_open() &&
            thumbnailFile.is_open() &&
            slideshowFile.is_open() &&
            getMD5(imageFile) == newPhoto->getImageChecksum() &&
            getMD5(slideshowFile) == newPhoto->getSlideshowChecksum() &&
            getMD5(thumbnailFile) == newPhoto->getThumbnailChecksum()
          )
        )
      {
        //close ifstreams
        imageFile.close();
        slideshowFile.close();
        thumbnailFile.close();
        
        //populate image
        lazyAddPhoto(imageName, slideshowName, thumbName, newPhoto);
      }
      //else reload image and scale it since changes have occured.
      else
      {
        //close ifstreams if open
        if(imageFile.is_open())
          imageFile.close();
        if(thumbnailFile.is_open())
          thumbnailFile.close();
          
        //populate image
        addPhoto(imageName, false, newPhoto);
      }

      if(imageFile.is_open())
        imageFile.close();
      if(slideshowFile.is_open())
        slideshowFile.close();
      if(thumbnailFile.is_open())
        thumbnailFile.close();
      
      //update progress bar
      status->incrementProgress();
      qApp->processEvents();
    }
    //------------------------------------------------------------
    //advance to next node   
    node = node.nextSibling();
    //------------------------------------------------------------
  }
  //------------------------------------------------------------
  //set loaded number
  resetNumLoadedPhotos();
  //------------------------------------------------------------  
}
//==============================================
void Subalbum::photoMoved(Photo* val)
{
  //decrease counter
  numPhotos--;
 
 //walk through list of photos and find specified photo
  Photo* current = firstPhoto;
  Photo* prev = NULL;
  while(current != NULL &&
        current != val)
  {
    prev = current;
    current = current->getNext();
  }

  if(current == val)
  {
    //update prev next pointer
    if(prev != NULL)
      prev->setNext(current->getNext());
    
    //update first and last pointers if necessary
    if(current == firstPhoto)
      firstPhoto = current->getNext();
    if(current == lastPhoto)
      lastPhoto = prev;
  }
    
  //set modified
  albm->setModified();
}
//==============================================
void Subalbum::syncPhotoList(PhotoWidget* item)
{
  //base case, no items
  if(item == NULL)
  {
    firstPhoto = NULL;
    lastPhoto = NULL;
    return;
  }
  
  //set first and last pointers
  firstPhoto = item->getPhoto();
  firstPhoto->setNext(NULL);
  lastPhoto = firstPhoto;
    
  //set all next pointers
  while(item->nextItem() != NULL)
  {
    item->getPhoto()->setNext( ((PhotoWidget*)item->nextItem())->getPhoto() );
    item = (PhotoWidget*)item->nextItem();
    lastPhoto = item->getPhoto();
    lastPhoto->setNext(NULL);
  }
}
//==============================================
int Subalbum::getSubalbumNumber()
{
  return number;
}
//==============================================
int Subalbum::getNumPhotos()
{
  return numPhotos;;
}
//==============================================
int Subalbum::getNumLoadedPhotos()
{
  return loadedPhotos;;
}
//==============================================
void Subalbum::resetNumLoadedPhotos()
{
  loadedPhotos = numPhotos;
}
//==============================================
void Subalbum::setModified()
{
  albm->setModified();
}
//==============================================

---