1

"""

     2

    Per-directory gallery state

     3

"""

     4

     5

import filesystem, image, html

     6

     7

from utils import lazy_load, lazy_load_iter

     8

     9

import math

    10

    11

class Folder (filesystem.Directory) :

    12

    """

    13

        A Folder is a filesystem Directory that contains any number of other Folders and Images.

    14

    """

    15

    16

    def __init__ (self, *args, **kwargs) :

    17

        super(Folder, self).__init__(*args, **kwargs)

    18

    19

        # info

    20

        self.title = None

    21

        self.description = None

    22

    23

    @lazy_load

    24

    def preview_dir (self) :

    25

        """

    26

            Load and return the Directory for previews

    27

        """

    28

    29

        return self.subdir(self.config.preview_dir, create=True)

    30

    31

    @lazy_load

    32

    def thumb_dir (self) :

    33

        """

    34

            Load and return the Directory for thumbs

    35

        """

    36

    37

        return self.subdir(self.config.thumb_dir, create=True)

    38

    39

    @lazy_load_iter

    40

    def subnodes (self) :

    41

        """

    42

            Load and return an ordered list of child-Nodes

    43

        """

    44

    45

        return super(Folder, self).subnodes(skip_dotfiles=True, sort=True)

    46

    47

    @lazy_load_iter

    48

    def subfolders (self) :

    49

        """

    50

            Load and return an ordered list of sub-Folders

    51

        """

    52

    53

        # filter out valid subfolders

    54

        for node in self.subnodes :

    55

            # skip non-dirs

    56

            if not node.is_dir() :

    57

                continue

    58

    59

            # skip the previews/thumbs dirs

    60

            if node.name in (self.config.preview_dir, self.config.thumb_dir) :

    61

                continue

    62

    63

            # ok

    64

            yield Folder(node)

    65

    66

    @lazy_load_iter

    67

    def images (self) :

    68

        """

    69

            Load and return an ordered/linked list of sub-Images

    70

        """

    71

    72

        prev = None

    73

    74

        for node in self.subnodes :

    75

            # skip non-relevant ones

    76

            if not node.is_file() or not self.config.is_image(filesystem.File(node)) :

    77

                continue

    78

    79

            # create new

    80

            img = image.Image(node)

    81

    82

            # link up

    83

            if prev :

    84

                img.prev = prev

    85

                prev.next = img

    86

    87

                # yield the linked-up prev

    88

                yield prev

    89

    90

            # continue

    91

            prev = img

    92

    93

        # and the last one

    94

        if prev :

    95

            yield prev

    96

    97

    @property

    98

    def page_count (self) :

    99

        """

   100

            Returns the number of pages needed to show this folder's images

   101

        """

   102

   103

        return int(math.ceil(len(self.images) / float(self.config.images_per_page)))

   104

   105

    def images_for_page (self, page) :

   106

        """

   107

            Returns the list of Images to be displayed for the given page, if any

   108

        """

   109

   110

        # offset to first image

   111

        offset = page * self.config.images_per_page

   112

   113

        # slice

   114

        return self.images[offset : offset + self.config.images_per_page]

   115

   116

    def html_file (self, page=0) :

   117

        """

   118

            Returns the File representing the .html for the given page

   119

        """

   120

   121

        if page :

   122

            return self.subfile("index_%d.html" % page)

   123

   124

        else :

   125

            return self.subfile("index.html")

   126

   127

    def index_images (self, for_update=True) :

   128

        """

   129

            Return a series of Images inside of this folder.

   130

   131

            If `for_update` is given, only images that are stale will be returned.

   132

        """

   133

   134

        for image in self.images :

   135

            if for_update and not image.stale() :

   136

                # skip 

   137

                continue

   138

   139

            yield image

   140