# -*- coding: iso-8859-1 -*-
"""
    MoinMoin - Gallery2 parser

    PURPOSE:
        This parser is used to visualize a couple of images as a thumbnail gallery.
        A description of an image including WikiName can be added optionally.
        By default, the image name and its creation date are shown.
        If you click on a thumbnail you get the webnails shown. By a menue you are able to toggle between the slides.

    USAGE:
      {{{
      #!Gallery2 [columns=columns],[filter=filter],[mode=mode],
                 [show_text=show_text],[show_date=show_date], [show_tools=show_tools],
                 [sort_by_name=sort_by_name],[sort_by_date=sort_by_date], [sort_by_alias=sort_by_alias],
                 [reverse_sort=reverse_sort],
                 [only_items=only_items],[template_itemlist=template_itemlist],
                 [thumbnail_width=thumbnail_width],[webnail_width=webnail_width],[text_width=text_width],
                 [image_for_webnail=image_for_webnail],
                 [border_thick=border_thick],[renew=renew],[help=help]
      * [image1.jpg alias]
      * [image2.jpg alias]
      }}}

    KEYWORD PARAMETERS:
        columns:           number of columns for thumbnails
        filter:            regex to select images
        show_text:         default is 1 description is shown
                           any other means no description
        show_date:         default is 1 date info from exif header if available is shown
        show_tools:        default is 1 icon toolbar is show any other disables this
        sort_by_name:      default is 1, the images are sorted by name, but not if only_items is 1
        sort_by_date:      default is 0, if set to 1 the images are sorted to the modification time
        sort_by_alias      default is 0, if set to 1 and only_items set to 1 it is used to order the images by the alias name
        reverse_sort:      default is 0, if set to 1 the file list is reversed
                           any other means no description
        mode:              default is 1 this means description below the image
                           any other number means description right of image
        only_items:        default is 0 if it is set to 1 only images which are described in listitem are shown
                           dependend on the order of the items
        template_itemlist: default is 0, if set to 1 an item list is shown which could be copied into the parser area. 
        border_thick:      default is 1 this is the thickness in pixeln of the outer frame
        renew:             default is 0 if set to 1 then all selected thumbnails_* and webnails_* removed.
                           Afterwards they are created from scratch.
        thumbnail_width:   default is 128
        webnail_width:     default is 640
        text_width:        default is 140		   
        image_for_webnail  default is 0 if set to 1 then the image is shown as preview and not the webnail
        help:              default is 0 if set a copy of the CALLING SEQUENCE is shown, 
                           (there are some new ideas around to show help to an user so this will be later replaced)

    OPTIONAL INPUTS:
        itemlist : if it is used and only_items is 1 then only the images in this list are ahown.
                   The alias text is used as description of the image instead of the file name


    EXAMPLE:
= GalleryTest =

== all images shown, one is decribed ==
{{{
{ { {
#!Gallery2
* [100_1185.JPG Bremen, SpaceCenter]
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2
* [100_1185.JPG Bremen, SpaceCenter]
}}}

== only thumbnails and only_items ==
{{{
{ { {
#!Gallery2 show_text=0,show_tools=0,show_date=0,columns=2,only_items=1
 * [100_1185.JPG Bremen, SpaceCenter]
 * [100_1194.JPG Bremen]
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2 show_text=0,show_tools=0,show_date=0,columns=2,only_items=1
 * [100_1185.JPG Bremen, SpaceCenter]
 * [100_1194.JPG Bremen]
}}}

== only_items by two columns and text right ==

{{{
{ { {
#!Gallery2 mode=2,columns=2,only_items=1
 * [100_1185.JPG Bremen, SpaceCenter]
 * [100_1194.JPG Bremen]
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2 mode=2,columns=2,only_items=1
 * [100_1185.JPG Bremen, SpaceCenter]
 * [100_1194.JPG Bremen, behind SpaceCenter]
}}}

----

== only_items by two columns, date supressed ==

{{{
{ { {
#!Gallery2 columns=2,only_items=1,show_date=0
 * [100_1185.JPG Bremen, SpaceCenter]
 * [100_1194.JPG Bremen, behind SpaceCenter]
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2 columns=2,only_items=1,show_date=0
 * [100_1185.JPG Bremen, SpaceCenter]
 * [100_1194.JPG Bremen, behind SpaceCenter]
}}}


== filter regex used, mode 2, icons and date supressed, one column and border_thick=5 ==
{{{
{ { {
#!Gallery2 columns=1,filter=100_118[0-5],mode=2,show_date=0,show_tools=0,border_thick=5
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2 columns=1,filter=100_118[0-7],mode=2,show_date=0,show_tools=0,border_thick=5
}}}

== other macro calls ==
{{{
{ { {
#!Gallery2 only_items=1,show_date=0
 * [100_1189.JPG [[MiniPage(||Bremen||SpaceCenter||\n|| ||SpaceJump||)]]]
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2 only_items=1,show_date=0
 * [100_1189.JPG [[MiniPage(||Bremen||SpaceCenter||\n|| ||SpaceJump||)]]]
}}}

== renew means always new thumbnails and webnails of selection ==
{{{
{ { {
#!Gallery2 only_items=1,show_date=0,show_tools=0,renew=1
 * [100_1189.JPG [[MiniPage(||["Bremen"]||SpaceCenter||\n|| ||SpaceJump||)]]]
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2 only_items=1,show_date=0,renew=1
 * [100_1189.JPG [[MiniPage(||["Bremen"]||SpaceCenter||\n|| ||SpaceJump||)]]]
}}}

== template_itemlist ==
{{{
{ { {
#!Gallery2 template_itemlist=1
* [100_1185.JPG Bremen, SpaceCenter]
} } }
}}}

Result: [[BR]]
 {{{
#!Gallery2 template_itemlist=1
* [100_1185.JPG Bremen, SpaceCenter]
}}}

== help to show Calling Sequence ==
 {{{
{ { {
#!Gallery2 help=1
} } }
}}}

Result: [[BR]]
{{{
#!Gallery2 help=1
}}}


    PROCEDURE:
      Upload some images to a page and start with the examples.
      Aliasing of the filenames is done by adding an itemlist, see example.

      This script requires the PIL (Python Imaging Library) and the
      EXIF routine from http://home.cfl.rr.com/genecash/digital_camera.html

      At the moment I have added the EXIF routine to the parsers dir.
      It's not the best place but during developing it is nice to have it there
      If you put it to another place you have to change the line
      from MoinMoin.parser import EXIF too.

      This routine requires the Action macro gallery2Image which is used to rotate or delete a selected image.
      Only users which have the rights to delete are able to execute this action macro.
      The icons of these are only shown if you have enough rights.

      The gallery2image macro does not take care of the EXIF header. This is lost by rotating.
      If a file is deleted by this macro it is moved to a bak file.

      Please remove the Version number from the script filename!

    RESTRICTIONS:
      The movie mode is not implemented at the moment. The implementation will be done in the action macro.
      
      
      If you rotate an image at the moment the exif is destroyed. PIL ignores the exif header.
      This is not a quite big problem normally files with an EXIF header are oriented correctly.

    Required Images:
      I have put them to wiki/modern/img/ dir. The icons were created by me. License: GPL

    attachment:to_bak.png
    attachment:to_left.png
    attachment:to_right.png
    attachment:to_slide.png
    attachment:to_full.png

    HISTORY:
    While recognizing how to write MiniPage I got the idea to write a Gallery Parser.
    We have used in our wikis in the past the Gallery macro of SimonRyan.
    I have tried to modify it a bit to change it for 1.3 but my python skills weren't enough
    or it was easier to write it completly new.
    So this one shows now a way how a Gallery could be used by the parser and an action Macro.
    Probably it is a good example for others who like to know how to do this

    MODIFICATION HISTORY:
        Version 1.3.3.-1
        @copyright: 2005 by Reimar Bauer (R.Bauer@fz-juelich.de)
        @license: GNU GPL, see COPYING for details.
        2005-03-26: Version 1.3.3-2 keyword renew added
                    creation of thumbnails and webnails in two calls splitted
                    Version 1.3.3-3 bug fixed if itemlist is given to describe only some of the images
                                    but only_items is not set to 1
                                    Example code changed
        2005-03-27: Version 1.3.3-4 Action macro added and the form to call it. User which have rights to delete
                                    could use the functions of gallery2Image.
        2005-08-03: Version 1.3.3-5 theme path for icons corrected and a platform independent path joining
                                    os.unlink removed as suggested by CraigJohnson
                                    sort_by_name is default if not only_items is 1
                                    optional sort_by_date could be used
                                    keyword template_itemlist added 
                                    keyword help added
                                    extra frame by mode=2 removed 
        2005-08-06: Version 1.3.5-6 slideshow mode added
                                    keyword image_for_webnail added
        2005-08-09: Version 1.3.5-7 syntax changed from GET to POST
                                    forms instead of links
                                    filenames from images submitted to gallery2image too
                                    new keyword sort_by_alias
                                    internal code clean up
                                    this version needs: gallery2image-1.3.5-5.py
        2005-08-14: Version 1.3.5-8 (TW) cleanup, please read the diff and PEP8
        
"""

Dependencies = []

from MoinMoin.action import AttachFile
from MoinMoin import wikiutil, config
from MoinMoin.Page import Page

import os, re, Image, StringIO

from MoinMoin.parser import EXIF

from MoinMoin.parser import wiki

#def ImageProcess(var):
#    f=open('/tmp/workfile.txt', 'w')
#    f.write(var)
#    f.close()

def get_files(kw, path, files, quotes, request):
    web = []
    full = []
    thumb = []
    exif_date = []
    img_type = []
    description = []
    
    ddict = {}
    n = len(quotes['image'])
    if n > 0:
        i = 0
        for txt in quotes['image']:
            ddict[txt] = quotes['alias'][i]
            i += 1    

    for attfile in files:
        # only files not thumb or webnails
        if attfile.find('thumbnail_') == -1 and attfile.find('webnail_') == -1:
            # only images
            if wikiutil.isPicture(attfile):               
                description.append(ddict.get(attfile, attfile))
                full.append(attfile)
                
                if kw['image_for_webnail'] == '1':
                    webnail = attfile
                else:
                    fname, ext = os.path.splitext(attfile)
                    if ext in ('.gif', '.png'):
                        img_type.append('PNG')
                        webnail = 'webnail_%s.png' % fname
                        thumbfile = 'thumbnail_%s.png' % fname
                    else:
                        img_type.append("JPEG")
                        webnail = 'webnail_%s.jpg' % fname
                        thumbfile = 'thumbnail_%s.jpg' % fname
  
                infile = os.path.join(path, attfile)
                if os.path.exists(infile):
                    web.append(webnail)
                    thumb.append(thumbfile)
                     
                f = open(infile, 'rb')
                tags = EXIF.process_file(f)
                if tags.has_key('EXIF DateTimeOriginal'):
                    date = str(tags['EXIF DateTimeOriginal'])
                    date = date.replace(':', '-', 2)
                else:
                    date = '--'
                exif_date.append(date)
                f.close()
      
    return thumb, web, full, exif_date, img_type, description  

def to_htmltext(text):        
    text = text.split(' ')
    text = '&nbsp;'.join(text)
    return text

def to_wikiname(request, formatter, text):
    ##taken from MiniPage
    out = StringIO.StringIO()
    request.redirect(out)
    wikiizer = wiki.Parser(text.strip(), request)
    wikiizer.format(formatter)
    naw = out.getvalue() # XXX "naw" ???
    request.redirect()
    del out
    return naw.strip()
        
def get_quotes(self, formatter):
    quotes = self.raw.split('\n')
    quotes = [quote.strip() for quote in quotes]
    quotes = [quote[2:] for quote in quotes if quote.startswith('* ')]

    image = []
    text = []
    
    for line in quotes:
        im, na = line[1:-1].split(' ', 1)
        text.append(na.strip())
        image.append(im.strip())

    return {
        'alias': text,
        'image': image,
    }


class Parser:
        
    def __init__(self, raw, request, **kw):
        self.raw = raw
        self.request = request
        self.form = request.form
        self._ = request.getText
        self.kw = {
            'sort_by_date': '0', # not implemented yet
            'sort_by_name': '1', 
            'sort_by_alias': '0', 
            'template_itemlist': '0', 
            'reverse_sort': '0',
            'border_thick': '1',
            'columns': '4',
            'filter': '.',
            'mode': '1',
            'help': '0',
            'show_text': '1',
            'show_date': '1',
            'show_tools': '1',
            'only_items': '0',
            'image_for_webnail': '0',
            'renew': '0',
            'thumbnail_width': '128',
            'webnail_width': '640',
            'text_width': '140',
        }

        for arg in kw.get('format_args', '').split(','):
            if arg.find('=') > -1:
                key, value = arg.split('=')
                self.kw[key] = wikiutil.escape(value, quote=1)

        self.kw['width'] = str((int(self.kw['thumbnail_width']) + int(self.kw['text_width'])))


    def format(self, formatter):
        kw = self.kw
        Dict = {}
        quotes = get_quotes(self, formatter)
        current_pagename = formatter.page.page_name
        attachment_path = AttachFile.getAttachDir(self.request, current_pagename, create=1)
 
        if kw['help'] == '1':
            self.request.write('''
<br>
{{{<br>
#!Gallery2 [columns=columns],[filter=filter],[mode=mode],<br>
           [show_text=show_text],[show_date=show_date], [show_tools=show_tools],<br>
           [sort_by_name=sort_by_name],[sort_by_date=sort_by_date],[sort_by_alias=sort_by_alias]<br>
           [reverse_sort=reverse_sort],<br>
           [only_items=only_items],[template_itemlist=template_itemlist],<br>
           [thumbnail_width=thumbnail_width],[webnail_width=webnail_width],[text_width=text_width],<br>
           [image_for_webnail=image_for_webnail],<br>
           [border_thick=border_thick],[renew=renew],[help=help]<br>
 * [image1.jpg alias]<br>
 * [image2.jpg alias]<br>
}}}<br>''')
            return    
        
        if kw['only_items'] == '1':
            all_files = quotes['image']
            
            if kw['sort_by_alias'] == '1':
                new_ordered_files = []
                alias_text = quotes['alias']
                
                i = 0
                for attfile in all_files:
                    infile = os.path.join(attachment_path, attfile)
                    ft_file = str(os.path.getmtime(infile)) + os.tmpnam()
                    Dict[alias_text[i]] = attfile
                    i += 1

                keys = Dict.keys()   
                keys.sort()
                for txt in keys:
                    new_ordered_files.append(Dict[txt])  

                all_files = new_ordered_files
                Dict.clear()
           
        else:
            all_files = os.listdir(attachment_path)

        result = []
        for test in all_files:
            if re.match(kw['filter'], test):
                result.append(test)
        all_files = result

        if not all_files:
            self.request.write("<br><br><h1>No matching image file found!</h1>")
            return

        if kw['sort_by_name'] == '1' and kw['only_items'] == '0': 
            all_files.sort()
          
        if kw['sort_by_date'] == '1':
            for attfile in all_files:
                infile = os.path.join(attachment_path, attfile)
                ft_file = str(os.path.getmtime(infile)) + os.tmpnam()
                Dict[ft_file] = attfile
       
            keys = Dict.keys()
            keys.sort()
            file_mdate = []
            for txt in keys:
                file_mdate.append(Dict[txt])
            all_files = file_mdate
            Dict.clear()
         
        if kw['reverse_sort'] == '1': 
            all_files.reverse()

        cells = []
        cell_name = []
        img = []
      
        thumb, web, full, exif_date, imgtype, description = get_files(kw, attachment_path, all_files, quotes, self.request)
        
        if kw['template_itemlist'] == '1':
            self.request.write('Copy the following listitems into the parser area. Replace alias with the label you want. Afterwards disable template_itemlist by setting it to 0:<BR>')
       
        i = 0
        for attfile in full:
            thumbfile = thumb[i]
            img_type = imgtype[i]

            infile = os.path.join(attachment_path, attfile)
            webnail = web[i]
            this_description = description[i]
            this_exif_date = exif_date[i]

            img.append(attfile)
            if kw['template_itemlist'] == '1':
                self.request.write(' * [%(attfile)s %(date)s]<br>' % {
                                   'attfile' : attfile,
                                   'date'    : 'alias'
                                    })

            thumbf = os.path.join(attachment_path, thumbfile)
            webf = os.path.join(attachment_path, webnail)

            if kw['renew'] == '1':
                if os.path.exists(thumbf):
                    os.unlink(thumbf)
                if os.path.exists(webf):
                    os.unlink(webf)

            if not os.path.exists(webf) or not os.path.exists(thumbf):
                im = Image.open(infile)
                if not os.path.exists(webf):
                    im.thumbnail(((int(kw['webnail_width'])),((int(kw['webnail_width'])))), Image.ANTIALIAS)
                    im.save(webf, img_type)
                if not os.path.exists(thumbf):
                    im.thumbnail(((int(kw['thumbnail_width'])),((int(kw['thumbnail_width'])))), Image.ANTIALIAS)
                    im.save(thumbf, img_type)
            
            alias_text = "%(this)s,%(all_other)s" % {
                             "this": this_description,
                             "all_other": '","'.join(description)}

            text = '''
<form action="%(baseurl)s/%(pagename)s" method="POST" enctype="multipart/form-data">
<tt>
<input type="hidden" name="action" value="gallery2image">
<input type="hidden" name="do" value="VS">
<input type="hidden" name="full" value="%(full)s">
<input type="hidden" name="alias" value="%(alias)s">
<input type="hidden" name="exif_date" value="%(exif_date)s">
<input type="hidden" name="target" value="%(target)s">
<input type="image" value="submit" src=%(submit)s>
</tt>
</form>
''' %       {
                'baseurl': self.request.getScriptname(),
                'pagename': wikiutil.quoteWikinameURL(current_pagename),
                'full': attfile + "," + ','.join(full),
                'alias': to_htmltext(this_description + "!,!" + '!,!'.join(description)),
                'exif_date': to_htmltext(this_exif_date + "," + ','.join(exif_date)),
                'target': webnail + "," + ','.join(web),
                'submit': AttachFile.getAttachUrl(current_pagename, thumbfile, self.request),
            }            
            cells.append(text)
            cell_name.append(attfile)
            i += 1

        result = []
        if len(full) == 0:
            result.append('Image not found')
           
        n = len(cells)
        cols = int(kw['columns'])
        rows = n/cols
        first = 0
        z = 1
        i = 0

        ############################################
        ##TODO: syntax change to formatter - later #
        ############################################

        # fixed width because of better visualisation on different browsers
        
        result.append('<table border="%(border_thick)s" valign="bottom">' % kw)
        l = 0
        for line in cells:
            if z == 1:
                if cols > 1 and n > 1:
                    if kw['mode'] == '1':
                        result.append('<td width="%(thumbnail_width)s">' % kw)
                        #result.append(formatter.table_cell(1))
                    else:
                        result.append('<td width="%(width)s">' % kw)
            if n > 1 and cols > 1:
                result.append('<table border="1" valign="center">')

            result.append('<tr valign="center">')
            # image align center
            result.append('<td align="center" valign="center" width="%(thumbnail_width)s">' % kw)
            result.append(line)
            result.append(formatter.table_cell(0))

            if kw['show_text'] == '1':
                if kw['mode'] == '1':
                    result.append(formatter.table_row(0))
                    result.append(formatter.table_row(1))
                    # text aligned left in mode 1
                    result.append('<td align="left" width="%(thumbnail_width)s">' % kw)
                else:
                    # text aligned on top in mode 2
                    result.append('<td valign="top" width="%(text_width)s">' % kw)

                result.append(to_wikiname(self.request, formatter, description[l]))
                
                result.append(formatter.table_cell(0))
                if kw['mode'] == '1':
                    result.append(formatter.table_row(0))
                l += 1

            if kw['show_date'] == '1':
                if kw['mode'] == '1':
                    result.append(formatter.table_row(1))
                    result.append(formatter.table_cell(1))
                    result.append(exif_date[i])
                    result.append(formatter.table_cell(0))
                    result.append(formatter.table_row(0))

            if kw['show_tools'] == '1':
                result.append(formatter.table_row(1))
                # tool bar centered
                result.append('<td align="center">')
                result.append('<table align="center">')
                result.append('<tr><td>')
                result.append('<form><tt>')
                result.append('<input type="hidden" name="action" value="AttachFile">')
                result.append('<input type="hidden" name="do" value=get>')
                result.append('<input type="hidden" name="target" value="%s">' % img[i])
                result.append('<input type="image" value="submit" src="/wiki/modern/img/to_full.png" title="load image">')
                result.append('</tt></form>')
                result.append('</td><td>')
                result.append('<form action="%(baseurl)s/%(pagename)s" method="POST" enctype="multipart/form-data"><tt>' % {
                                 'baseurl': self.request.getScriptname(),
                                 'pagename': wikiutil.quoteWikinameURL(current_pagename)})

                result.append('<input type="hidden" name="action" value="gallery2image">')
                result.append('<input type="hidden" name="do" value="VS">')
                result.append('<input type="hidden" name="full" value="%s">' % attfile + "," + ','.join(full))
                result.append('<input type="hidden" name="alias" value="%s">' % to_htmltext(description[0] + "!,!" + '!,!'.join(description)))
               
                result.append('<input type="hidden" name="target" value="%s">' % webnail + "," + ','.join(web))
                result.append('<input type="hidden" name="exif_date" value="%s">' % to_htmltext(this_exif_date + "," + ','.join(exif_date)))
                #result.append('<input type="hidden" name="target" value="%s">' % ','.join(img))
                result.append('<input type="image" value="submit" src="/wiki/modern/img/to_slide.png" title="slide_show">') # XXX make theme variable
                result.append('</tt></form>')
                result.append('</td>')

                if self.request.user.may.delete(current_pagename):
                    result.append('<td>')

                    result.append('<form action="%(baseurl)s/%(pagename)s" method="POST" enctype="multipart/form-data"><tt>' % {
                                      'baseurl': self.request.getScriptname(),
                                      'pagename': wikiutil.quoteWikinameURL(current_pagename)})

                    result.append('<input type="hidden" name="action" value="gallery2image">')
                    result.append('<input type="hidden" name="do" value="RL">')
                    result.append('<input type="hidden" name="target" value="%s">' % img[i])
                    result.append('<input type="image" value="submit" src="/wiki/modern/img/to_left.png" title="rotate to left">')
                    result.append('</tt></form>')
                    result.append('</td><td>')
                    result.append('<form action="%(baseurl)s/%(pagename)s" method="POST" enctype="multipart/form-data"><tt>' % {
                                      'baseurl': self.request.getScriptname(),
                                      'pagename': wikiutil.quoteWikinameURL(current_pagename)})

                    result.append('<input type="hidden" name="action" value="gallery2image">')
                    result.append('<input type="hidden" name="do" value="RR">')
                    result.append('<input type="hidden" name="target" value="%s">' % img[i])
                    result.append('<input type="image"  value="submit" src="/wiki/modern/img/to_right.png" title="rotate to right">')

                    result.append('</tt></form>')
                    result.append('</td><td>')
                    result.append('<form action="%(baseurl)s/%(pagename)s" method="POST" enctype="multipart/form-data"><tt>' % {
                                      'baseurl': self.request.getScriptname(),
                                      'pagename': wikiutil.quoteWikinameURL(current_pagename)})

                    result.append('<input type="hidden" name="action" value="gallery2image">')
                    result.append('<input type="hidden" name="do" value="RM">')
                    result.append('<input type="hidden" name="target" value="%s">' % img[i])
                    result.append('<input type="image" value="submit" src="/wiki/modern/img/to_bak.png" title="move to bak">')
                    result.append('</tt></form>')
                    result.append('</td>')
                result.append('</tr>')
                result.append('</table>')

            result.append(formatter.table_cell(0))
            if kw['show_date'] == '1':
                if not kw['mode'] == '1':
                    result.append(formatter.table_cell(1))
                    result.append(exif_date[i])
                    result.append(formatter.table_cell(0))
            if kw['show_tools'] == '1':
                result.append(formatter.table_row(0))
            if n > 1 and cols > 1:
                result.append(formatter.table(0))
            if z != cols and i < n-1:
                result.append(formatter.table_cell(1))
            if z == cols:
                result.append(formatter.table_cell(0))
                result.append(formatter.table_row(0))
            z += 1
            i += 1
            if z > cols:
                z = 1

        result.append(formatter.table(0))
        ##Output
        self.request.write(''.join(result))

