#!/usr/bin/env python
#
# Copyright 2012 Ville Rantanen
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see .
import sys,os
import re
import urllib
import shutil
import csv
import subprocess
from math import ceil
from datetime import datetime
# (c) ville.rantanen@helsinki.fi
__version__='1.7'
webfilesearch=re.compile('.*index.html$|.*gallerystyle.css$|.*galleryscript.js$|.*descriptions.csv$|.*info.txt$|\..*',re.I)
imagesearch=re.compile('.*\.jpg$|.*\.jpeg$|.*\.gif$|.*\.png$|.*\.svg$|.*\.pdf$',re.I)
vectorsearch=re.compile('.*\.svg$|.*\.pdf$',re.I)
#gifsearch=re.compile('.*gif$',re.I)
excludepaths=re.compile('_med|_tn|\..*')
doublequotes=re.compile('"')
singlequotes=re.compile("'")
stripquotes=re.compile('^"|"$')
def getheader(path,parent,title=""):
if title=="":
title=unicode(os.path.basename(path),encoding="utf8").encode('ascii', 'xmlcharrefreplace')
return '''
'''+title+'''
'''
def getfooter():
return '''
'''
def getimagelist(path,options=False):
''' Returns a list of images matching the regex '''
list=os.listdir(path)
imgs=[]
for f in list:
if (imagesearch.match(f)) and (os.path.isfile(os.path.join(path,f))):
imgs.append(f)
if options:
if options.timesort:
imgs.sort(key=lambda f: os.path.getmtime(os.path.join(path, f)),reverse=options.reverse)
else:
imgs.sort(reverse=options.reverse)
else:
imgs.sort()
return imgs
def getfiletimes(path,list):
''' Returns a list of modification times '''
times=[]
for p in list:
times.append(int(os.path.getmtime(os.path.join(path,p))))
return times
def getnonimagelist(path,options):
''' Returns a list of files not matching the image match regex '''
list=os.listdir(path)
files=[]
if not options.attachments:
return files
for f in list:
if (not webfilesearch.match(f)) and (not imagesearch.match(f)) and (os.path.isfile(os.path.join(path,f))):
files.append(f)
if options.timesort:
files.sort(key=lambda f: os.path.getmtime(os.path.join(path, f)),reverse=options.reverse)
else:
files.sort(reverse=options.reverse)
return files
def getpathlist(path,options=False):
''' Returns a list of subfolders not matching the exclusion regex '''
list=os.listdir(path)
paths=[]
for d in list:
if (not excludepaths.match(d)) and (os.path.isdir(os.path.join(path,d))):
paths.append(d)
if options:
if options.timesort:
paths.sort(key=lambda f: os.path.getmtime(f),reverse=options.reverse)
else:
paths.sort(reverse=options.reverse)
else:
paths.sort()
return paths
def pathscript(path,list):
''' Returns the javascript string of pathlist and pathimage arrays '''
scrstr=''
return scrstr
def pathlinks(path,list):
''' Returns the HTML string of subfolders '''
pathstr='
'
return pathstr
def imagescript(path,list):
''' Returns the javascript string of imagelist and imagedesc '''
strout=''
return strout
def imagelinks(path,list):
''' Returns the HTML string of images '''
strout='
'
return strout
def filescript(path,list):
''' Returns the javascript string of filelist '''
strout=''
return strout
def filelinks(path,list):
''' Returns the HTML string of non image files '''
strout='
'
return strout
def cleanthumbs(path):
''' clears _med and _tn for unused thumbs '''
print('clearing unused thumbs...')
if os.path.exists(os.path.join(path,'_tn')):
clearfolder(path,os.path.join(path,'_tn'),re.compile("(^tn_)(.*)(.jpg)"))
if os.path.exists(os.path.join(path,'_med')):
clearfolder(path,os.path.join(path,'_med'),re.compile("(^med_)(.*)(.jpg)"))
return
def clearfolder(path,tnpath,regex):
''' clears given folder '''
list=getimagelist(tnpath)
for i in list:
f=regex.match(i)
try:
if not os.path.exists(os.path.join(path,f.group(2))):
print('removing '+i)
os.remove(os.path.join(tnpath,i))
except:
continue
return
def createthumbs(path,list,options):
''' Runs imagemagick Convert to create medium sized and thumbnail images '''
if len(list)==0:
return
if not os.path.exists(os.path.join(path,'_tn')):
os.mkdir(os.path.join(path,'_tn'))
if not os.path.exists(os.path.join(path,'_med')):
os.mkdir(os.path.join(path,'_med'))
n=1
nsum=len(list)
r=str(options.width)
res=r+'x'+r+'>'
for i in list:
outmedium=os.path.join(path,'_med','med_'+i+'.jpg')
outthumb=os.path.join(path,'_tn','tn_'+i+'.jpg')
inpath=os.path.join(path,i)
if (options.force) and os.path.exists(outmedium):
os.unlink(outmedium)
if (options.force) and os.path.exists(outthumb):
os.unlink(outthumb)
if (not os.path.exists(outmedium)):
print('Medium.. '+i+' '+str(n)+'/'+str(nsum))
create_medium_bitmap(inpath,outmedium,r,link=options.link,vector=vectorsearch.match(i))
if (not os.path.exists(outthumb)):
print('Thumbnail.. '+i+' '+str(n)+'/'+str(nsum))
create_thumb_bitmap(outmedium,outthumb,vector=vectorsearch.match(i))
n+=1
return
def create_medium_bitmap(infile,outfile,r,link=False,vector=False):
if link:
os.symlink(infile,outfile)
return
res=r+'x'+r+'>'
if vector:
convargs=['convert','-density','300x300',infile+'[0]','-background','white','-flatten','-resize',res,'-quality','97',outfile]
else:
convargs=['convert','-define','jpeg:size='+r+'x'+r,infile+'[0]','-background','white','-flatten','-resize',res,'-quality','85',outfile]
convp=subprocess.call(convargs)
return
def create_thumb_bitmap(infile,outfile,vector=False):
if vector:
convargs=['convert','-density','300x300',infile,'-background','white','-flatten','-thumbnail','90x90^','-gravity','Center','-crop','90x90+0+0','+repage','-quality','75',outfile]
else:
convargs=['convert','-define','jpeg:size=300x300',infile,'-background','white','-flatten','-thumbnail','90x90^','-gravity','Center','-crop','90x90+0+0','+repage','-quality','75',outfile]
convp=subprocess.call(convargs)
return
def getdescriptions(path,list):
''' Read descriptions.csv file and returns a list of descriptions.
Missing descriptions are replaced with the file name. '''
if not os.path.exists(os.path.join(path,'descriptions.csv')):
return list
desc=[i for i in list]
reader = csv.reader(open(os.path.join(path,'descriptions.csv'),'rb'),
delimiter='\t',
doublequote=False,
escapechar='\\',
quoting=csv.QUOTE_NONE)
for row in reader:
if len(row)>1:
if row[0] in list:
i=list.index(stripquotes.sub('',row[0]))
desc[i]=stripquotes.sub('',row[1])
return desc
def getinfo(path):
''' Read info.txt file and returns the content.
Missing info file returns empty string. '''
if not os.path.exists(os.path.join(path,'info.txt')):
return ''
reader = open(os.path.join(path,'info.txt'),'r')
return unicode(reader.read(),encoding="utf8").encode('ascii','xmlcharrefreplace')
def crumblinks(crumbs):
''' Create the HTML string for crumb trails '''
strout='
'
return strout
def nicestring(s):
''' Returns a nice version of a long string '''
if len(s)<20:
return s
s=s.replace("_"," ")
s=s.replace("-"," ")
if len(s)>30:
s=s[0:26]+".."+s[-3:]
return s
def sizestring(size):
''' Returns human readable file size string '''
for x in ['b','kb','Mb','Gb','Tb']:
if size < 1024.0:
if (x=='b') | (x=='kb'):
return "%d%s" % (size, x)
else:
return "%3.1f%s" % (size, x)
size /= 1024.0
def traverse(path,crumbs,inputs,options):
''' The recursive main function to create the index.html and seek sub folders '''
print(path)
if len(crumbs)==1:
header=getheader(path,'../'*(len(crumbs)-1),inputs[0][1])
else:
header=getheader(path,'../'*(len(crumbs)-1))
print(len(crumbs))
pathlist=getpathlist(path,options)
imagelist=getimagelist(path,options)
filelist=getnonimagelist(path,options)
print(str(len(pathlist))+' paths')
print(str(len(imagelist))+' images')
print(str(len(filelist))+' other files')
crumbstring=crumblinks(crumbs)
if len(pathlist)>0:
pathstring=pathlinks(path,pathlist)
pathjs=pathscript(path,pathlist)
else:
pathstring=''
pathjs=''
filestring=filelinks(path,filelist)
filejs=filescript(path,filelist)
if len(imagelist)>0:
imagestring=imagelinks(path,imagelist)
imagejs=imagescript(path,imagelist)
else:
imagestring=''
imagejs=''
f=open(os.path.join(path,"index.html"),"w")
f.write(header)
f.write('')
f.write(pathjs)
f.write(imagejs)
f.write(filejs)
f.write(crumbstring)
f.write(pathstring)
f.write('
'+getinfo(path)+'
')
f.write('')
f.write(imagestring)
f.write(filestring)
f.write('')
f.write(getfooter())
f.close()
createthumbs(path,imagelist,options)
for p in pathlist:
nextcrumbs=[i for i in crumbs]
nextcrumbs.append(os.path.join(path,p))
traverse(os.path.join(path,p),nextcrumbs,inputs,options)
return
def setupoptions():
''' Setup the command line options '''
from argparse import ArgumentParser
parser=ArgumentParser()
parser.add_argument("-v",action='version', version=__version__)
parser.add_argument("-r",action="store_true",dest="reverse",default=False,
help="Reverse sort orded")
parser.add_argument("-t",action="store_true",dest="timesort",default=False,
help="Sort by file modification time")
parser.add_argument("-a",action="store_false",dest="attachments",default=True,
help="Disable attachments")
parser.add_argument("-g",type=str,dest="gallery",default="Gallery",
help="Name for the root gallery (Default: %(default)s)")
parser.add_argument("-w",type=int,dest="width",default=850,
help="Medium image size (Default: %(default)s)")
parser.add_argument("startpath",type=str,action="store",default=os.path.abspath('.'),nargs='?',
help="Root path of the gallery")
options=parser.parse_args()
options.startpath=os.path.abspath(options.startpath)
options=setupdefaultoptions(options)
return options
def setupdefaultoptions(options):
''' Adds the missing options for the options object '''
if 'attachments' not in options:
options.attachments=True
if 'clean' not in options:
options.clean=False
if 'force' not in options:
options.force=False
if 'gallery' not in options:
options.gallery="Gallery"
if 'link' not in options:
options.link=False
if 'recursive' not in options:
options.recursive=True
if 'reverse' not in options:
options.reverse=False
if 'timesort' not in options:
options.timesort=False
if 'width' not in options:
options.width=850
return options
def execute_plain():
''' Main execution function '''
options=setupoptions()
options=setupdefaultoptions(options)
# Copy all resources to target folder
pathname=os.path.dirname(os.path.realpath(sys.argv[0]))
fullpath=os.path.abspath(pathname)
shutil.copyfile(os.path.join(fullpath,'gallerystyle.css'),os.path.join(options.startpath,'gallerystyle.css'))
shutil.copyfile(os.path.join(fullpath,'galleryscript.js'),os.path.join(options.startpath,'galleryscript.js'))
inputs=[]
inputs.append((None,options.gallery,None))
traverse(options.startpath,[options.startpath],inputs,options)
return
if __name__ == "__main__":
execute_plain()
+'.jpg)