Jean-Michel Fayard > Image-Kimdaba-0.5 > Image::Kimdaba

Download:
Image-Kimdaba-0.5.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.5   Source  

NAME ^

Image::Kimdaba - Parser for the KDE Image Database

See here : http://ktown.kde.org/kimdaba

SYNOPSIS ^

        use Image::Kimdaba;
        use English qw( -no_match_vars ) ;
        
        my @ListOfPictures;
        
        my $folder=getRootFolder();
        parseDB( "$folder" );
        
        print "Your actual Kimdaba settings are :\n";
        while( my ($attr, $value) = each %kimdabaconfig)
        {
            print "\t$attr => $value\n";
        }
        print "\n";
        
        my $nb1= scalar keys %imageattributes;
        my $nb2= scalar keys %imageoptions;
        print "Following options were present in your $nb1 pictures :\n";
        while( my ($option,$r_values) = each %alloptions )
        {
            my $nb = scalar @$r_values;
            print "\t$nb $option\n";
        }
        print "\n";
        
        local $, = "\n" ; # print bla,bla prints "bla\nbla"
        
        print "\n\n== NO Keywords  (ten first) ==\n";
        @ListOfPictures=matchAnyOption( "Keywords" => [] );
        print sort(@ListOfPictures[0..9]);
        
        print "\n\n== Holiday  ==\n";
        @ListOfPictures=matchAnyOption( "Keywords" => [ "holiday" ] );
        print sort(@ListOfPictures);
        
        print "\n\n== ANNE HELENE ==\n";
        @ListOfPictures=matchAnyOption( "Persons" => [ "Anne Helene" ] );
        print sort(@ListOfPictures);
        
        print "\n\n== ANY OF (JESPER, ANNE HELEN) ==\n";

        @ListOfPictures=matchAnyOption( "Persons" => [ "Jesper" , "Anne Helene" ] );
        print sort(@ListOfPictures);
        
        print "\n\n== ALL OF (JESPER, ANNE HELEN) ==\n";
        @ListOfPictures=matchAllOptions( "Persons" => [ "Jesper" , "Anne Helene" ] );
        print sort(@ListOfPictures);
        
        print "\n\n== PERSONS=Jesper, Locations=Mallorca ==\n";
        @ListOfPictures=matchAllOptions( 
                "Persons" => [ "Jesper" ],
                "Locations" => [ "Mallorca" ]
                );
        print sort(@ListOfPictures);
        
        
        
        $, = "" ; # print bla,bla prints "blabla"
        
        print "\n\n==Print all infos known about specific pictures\n";
        print "\n\n== Drag&Drop pictures from Kimdaba  ==\n";
        @ListOfPictures=letMeDraganddropPictures();
        printImage( $_ ) foreach @ListOfPictures;

DESCRIPTION ^

From the website : http://ktown.kde.org/kimdaba

KimDaBa or KDE Image Database is a tool which you can use to easily sort your images. It provides many functionnalities to sort them and find them easily.

Datastructures

The infos available in the database are directly translated in following perl datastructures. (See the index.xml file to see how it looks like)

note : the reading of man perllol is highly recommended

%imageattributes

HASH OF (url of the picture, REF. HASH OF (attribute, value) )

Now and in the rest of the document, url is given locally from the root directory, such as "Folder1/Subfolder/img001.jpg", it's neither file:/home/user/Images/Folder1/Subfolder1/img001.jpg nor http://www.google.com/images/logo.gif

An HASH corresponding to this url could be

        (
        monthFrom=>"1",
        dayFrom=>"18",
        hourFrom=>"19",
        yearTo=>"0",
        monthTo=>"0",
        md5sum=>"7f120e3cfb698ce0d7bb6e4e454c1a8b",
        minuteFrom=>"29",
        file=>"2005-01-09-Gif/img_0290.jpg",
        label=>"img_0290",
        angle=>"0",
        dayTo=>"0",
        secondFrom=>"46",
        yearFrom=>"2005",
        description=>""
        )

%imageoptions

HASH of (url, REF. HASH OF (optoin, REF. LIST OF value) )

url is given locally from the root directory, such as "Folder1/Subfolder/img001.jpg"

An HASH corresponding to this url could be

        (
        Keywords =>     [ "holiday"     ],
        Locations =>    [ "Mallorca"    ],
        Persons =>      [ "Anne Helene", "Jesper" ]
        )

%alloptions

HASH of (option, REF. LIST of values)

Could be something like :

        (
        Keywords =>     [ "beers", "holiday", "new wave", "silo falls over", "Anne Helene's 30 years birthday" ]m
        Locations =>    ...,
        Persons =>      ...,
        OtherCategory => ...
        )

%membergroups

membergroups are called categories depending on your version of Kimdaba.

HASH : (Locations => REF (HASH : USA => [ Chicago, Los Angeles ] ) )

Beware, you can have loops between membergroups.

%kimdabaconfig

HASH of (attributes, values)

Fast all KimDaBa settings are stored in the index.xml file, as attribute of the "KimDaBA/config" XML element. So using this hash you can access many of the user preferences, for example it could be something like :

        ( 
        viewSortTye=>>"0",
        passwd=>"",
        ensureImageWindowsOnScreen=>"1",
        viewerCacheSize=>"25",
        albumCategory=>"",
        showDrawings=>"1",
        htmlBaseURL=>"file:///home2/jmfayard/public_html",
        previewSize=>"256",
        thumbSize=>"64",
        displayLabels=>"1",
        launchViewerFullScreen=>"0",
        windowWidth-0=>"800",
        autoShowThumbnailView=>"0",
        showInfoBox=>"1",
        windowWidth-1=>"800",
        slideShowWidth_1280=>"600",
        viewerHeight_1280=>"450",
        fromDate=>"2005-01-01",
        htmlDestURL=>"file:///home2/jmfayard/public_html",
        trustTimeStamps=>"0",
        windowHeight-0=>"600",
        thumbNailBackgroundColor=>"#000000",
        windowHeight-1=>"600",
        slideShowInterval=>"5",
        toDate=>"2006-01-01",
        exclude=>"1",
        infoBoxPosition=>"6",
        locked=>"0",
        showDate=>"1",
        imageDirectory=>"/tmp/kimdaba-demo-jmfayard",
        searchForImagesOnStartup=>"1",
        autoSave=>"5",
        version=>"1",
        viewerWidth_1280=>"600",
        launchSlideShowFullScreen=>"0",
        showDescription=>"1",
        maxImages=>"100",
        useEXIFComments=>"1",
        useEXIFRotate=>"1",
        showTime=>"1",
        htmlBaseDir=>"/home2/jmfayard/public_html",
        slideShowHeight_1280=>"450",
        )

Fonctions

&letMeDraganddropPictures()

        print "\n\n== Drag&Drop pictures from Kimdaba  ==\n";
        @ListOfPictures = &letMeDraganddropPictures();

Wait until the user drag and drop pictures from Kimdaba and Konqueror and return a list of url.

&matchAllOptions(HASH of (option => REF List of values))

Returns a list of urls. See the example in the synopsis.

&matchAnyOption(HASH of (option => REF List of values))

Returns a list of urls. See the example in the synopsis.

&getRootFolder()

        my $folder=getRootFolder();
        parseDB( "$folder" );

Returns the absolute path of the root directory. You should run the demo, keep the files, and use /tmp/kimdaba-demo-$USER when you are experimenting. Thanks to this function, the root directory can - passed as first argument on the command line ($ kim_script /tmp/kimdaba-demo-$USER ) - or will be asked to the user

&parseDB( $folder )

Readonly access to most information available in the index.xml file. To modify a database, see &makeKimFile()

&printImage( url )

        printImage( $url );

Interesting to debug. Its code also shows how to access the hashes %imageattributes and %imageoptions :

        sub printImage {
            my ($file)= @_;
        
            print "=== $file ===\n" ;
            print "Attributes : ";
            my %attributes = %{ $imageattributes{$file} } ;
            while( my ($attr, $value) = each( %attributes ) )
            {
                print " $attr=>$value ; ";
            }
            print "\n";
                
            my %options = %{ $imageoptions{$file} };
            print "Options: \n" ;
            while( my ($key, $r_values) = each( %options ) )
            {
                print "\t$key ==> ", join('; ', @$r_values ) , "\n";
            }
            print "\n";
        }

&makeKimFile( $destdir, $name, @list )

Instead of modifying directly the database (which could easily be dangerous for your data), you write a kimdaba export file (*.kim) then you use the import fonction in kimdaba (no dangerous, you are in control)

A .kim file is a zip archive containning an index.xml file, and a Thumbnail directory. You just have to create the index.xml file (say in '/tmp') then you call :

  C<makeKimFile( "/tmp", "perl_output.kim", @ListOfPictures );>

where

        /tmp/index.xml          is the file created by you
        /tmp/perl_output.kim    is the resulting kimdaba import ile
        @ListOfPictures         is a list of urls present in /tmp/index.xml

Not that the KimDaBa import feature has some limitations.

Example :

        use Image::Kimdaba;
        
        my @ListOfPictures;
        
        my $folder=getRootFolder();
        parseDB( "$folder" );
        
        print "\n\n== Drag&Drop pictures from Kimdaba  ==\n";
        @ListOfPictures=letMeDraganddropPictures();
        print join("\n", sort(@ListOfPictures));
        print "--\n";
        
        my $destdir="/tmp";
        open( EXPORT, "> ${destdir}/index.xml");
        print EXPORT <<FIN
        <?xml version="1.0" encoding="UTF-8"?>
        <KimDaBa-export location="external" >
        FIN
        ;
        
        for my $url (@ListOfPictures)
        {
            my $description="yeah! I changed the description";
            my $md5sum="";
            if (
                (exists $imageattributes{$url})
                &&
                (exists $imageattributes{$url}{'md5sum'})
                &&
                (! $imageattributes{$url}{'md5sum'} eq "")
               )
            {
                $md5sum="md5sum=\"$imageattributes{$url}{'md5sum'}\" ";
            }
                
            
            my $value="Test Add Another Keyword";
            print EXPORT <<FIN
         <image description="$description" $md5sum file="$url" >
          <options>
           <option name="Keywords" >
            <value value="Test Add a keyword" />
            <value value="$value" />
           </option>
          </options>
         </image>
        FIN
            ;
        }
        
        print EXPORT <<FIN
        </KimDaBa-export>
        FIN
        ;
        close( EXPORT );
        
        
        makeKimFile( $destdir, "perl_export.kim", @ListOfPictures);

BUGS/CAVEATS/etc ^

A lot ;-)

AUTHOR ^

Jean-Michel Fayard ; jmfayard{at}moufrei.de

SEE ALSO ^

perllol

syntax highlighting: