1

"""

     2

    Some additional helpers

     3

"""

     4

     5

import datetime, calendar

     6

     7

import qmsk.web.helpers

     8

     9

import preferences, urls, config

    10

    11

class Helpers (qmsk.web.helpers.Helpers) :

    12

    """

    13

        Our set of helpers, inheriting from base helpers

    14

    """

    15

    22

    def tz_name (self, tz) :

    23

        """

    24

            Returns a string describing the given timezone

    25

        """

    26

    27

        return self.now().strftime(config.TIMEZONE_FMT)

    28

    29

    def fmt_month (self, date) :

    30

        """

    31

            Formats a month

    32

        """

    33

    34

        return date.strftime(config.MONTH_FMT)

    35

    36

    def fmt_weekday (self, wday) :

    37

        """

    38

            Formats an abbreviated weekday name

    39

        """

    40

    41

        return calendar.day_abbr[wday]

    42

    43

    def build_date (self, month, mday) :

    44

        """

    45

            Returns a datetime.date for the given (month.year, month.month, mday)

    46

        """

    47

    48

        return datetime.date(month.year, month.month, mday)

    49

    50

    def now (self) :

    51

        """

    52

            Build current time

    53

        """

    54

    55

        return self.ctx['prefs'][preferences.timezone].localize(datetime.datetime.now())

    56

    57

    def today (self) :

    58

        """

    59

            Build today's date

    60

        """

    61

    62

        return self.now().date()

    63

    64

    def is_today (self, date) :

    65

        """

    66

            Checks if the given date is today

    67

        """

    68

    69

        # construct current date

    70

        return date == self.today()

    71

    72

    def is_this_month (self, month) :

    73

        """

    74

            Checks the given month is the current month

    75

        """

    76

    77

        today = self.today()

    78

    79

        return (month.year == today.year and month.month == today.month)

    80

    83

        """

    85

   104

        else :

   106

   107

    def prev_month (self, month) :

   108

        """

   110

        """

   117

   118

    def next_month (self, month) :

   119

        """

   121

        """

   128

   129

    def fmt_time (self, time=None) :

   130

        """

   131

            Format given time, or current time

   132

        """

   133

   134

        # defaults

   135

        if not time :

   136

            time = self.now()

   137

   138

        return time.strftime(self.ctx['prefs'][preferences.time_format])

   139

   140

    def fmt_date (self, date=None) :

   141

        """

   142

            Format given date, or current date

   143

        """

   144

   145

        # defaults

   146

        if not date :

   147

            date = self.now()

   148

   149

        return date.strftime(self.ctx['prefs'][preferences.date_format])

   150

   151

    def build_url (self, url, **params) :

   152

        """

   153

            Build URL with our request object

   154

        """

   155

   156

        return url.build(self.ctx['req'], **params)

   157

   158

    def utc_timestamp (self, dtz) :

   159

        """

   160

            Build an UTC timestamp from the given datetime

   161

        """

   162

   163

        return urls.types['ts'].build(dtz)

   164

   165

    def skip_next (self, count, skip) :

   166

        """

   167

            Return skip offset for next page

   168

        """

   169

   170

        return count + skip

   171

   172

    def skip_page (self, count, page) :

   173

        """

   174

            Skip to page

   175

        """

   176

   177

        if page :

   178

            return count * page

   179

   180

        else :

   181

            return None

   182

   183

    def skip_prev (self, count, skip) :

   184

        """

   185

            Return skip offset for previous page, None for first page

   186

        """

   187

   188

        if skip > count :

   189

            return skip - count

   190

   191

        else :

   192

            return None

   193

   194

    def max (self, *values) :

   195

        """

   196

            Returns the largest of the given values

   197

        """

   198

   199

        return max(values)

   200

   201

    def select_options (self, key_values, selected_key) :

   202

        """

   203

            Render a series of <option> tags for <select>

   204

        """

   205

   206

        return '\n'.join(

   207

            '\t<option%s%s>%s</option>' % (

   208

                ' value="%s"' % key if key != value else '',

   209

                ' selected="selected"' if key == selected_key else '',

   210

                value

   211

            ) for key, value in key_values

   212

        )

   213

   214

    def prev_date (self, date) :

   215

        """

   216

            Returns the previous date for the given datetime-date

   217

        """

   218

   219

        return datetime.datetime(date.year, date.month, date.day, tzinfo=date.tzinfo) - datetime.timedelta(days=1)

   220

   221

    def next_date (self, date) :

   222

        """

   223

            Returns the previous date for the given datetime-date

   224

        """

   225

   226

        return datetime.datetime(date.year, date.month, date.day, tzinfo=date.tzinfo) + datetime.timedelta(days=1)

   227