Processing Instruction - Schedule

Background and rationale

See schedule.py parser on the need of a new processing instruction. Briefly, it allows the schedule.py to be called directly rather than as argument of #format. This means that it should be possible to schedule the release and withdrawal of pages formatted but parsers other then the standard wiki parser (although this is untested and might need some additional coding).

Description

A new processing instruction, #schedule, is included to facilitate the release and withdrawal of pages to read-only users via the schedule.py parser.

Usage

#schedule [YYYY-DD-MM[@HH:MM][ YYYY-MM-DD[@HH:MM]]][ silent]

or 

#schedule SomethingSchedule

See schedule.py parser for the description of the arguments.

Example

See schedule.py parser for examples.

Prerequisites

An addtional import is required, viz. import time, which should be added with other imports at the top of the code in Page.py.

To allow the processing instruction #schedule to be recognised MoinMoin.page.py needs to be modified in the following four places. In addition to adding an new processing instruction, a new special page type, hidden, also is created by the inserted code.

In the function MoinMoin.page.parse_processing_instructions, add the following code in the position indicated.

Additional code 1

   1             elif verb == "schedule": #added to schedule release [IanRiley 06.01.2019]
   2                 # pi-format takes priority over pi-schedule
   3                 if pi['format'] != 'schedule' and args.strip():            
   4                     pi['schedule'] = args.strip()

Insertion position 1

   1     def parse_processing_instructions(self):
   2 ...
   3         for verb, args in meta:
   4 ...
   5             elif verb == "pragma":
   6 ...
   7 
   8 #Additional code goes here.

In the function MoinMoin.page.send_page, add the following two sections of code in the positions indicated.

Additional code 2

   1         release_page = True
   2         if 'schedule' in pi:
   3             # check schedule and release for reading [IanRiley 06.01.2019]
   4             Scheduler = wikiutil.searchAndImportPlugin(request.cfg, "parser", "schedule")
   5             checker = Scheduler('', request).process_schedule_args
   6             release_page, release_silent, release_msg, release_err, release_args = checker(self.page_name, pi['schedule'])
   7             if release_msg:
   8                 request.release_msg = release_msg
   9             # do not send msg to read-only users or when previewing from page
  10             if request.user.may.write(self.page_name)  and not self.__body_modified:
  11                 # leading '!' in msg class idicates a sticky msg that cannot be cleared
  12                 # this requires patching theme/__init__.py
  13                 if release_msg and not (release_msg, "!info") in request.theme._status:
  14                      request.theme.add_msg(release_msg, "!info")
  15                 if release_err and not (release_err, "!warning") in request.theme._status:
  16                      request.theme.add_msg(release_err, "!warning")
  17             elif request.user.may.read(self.page_name):
  18                 if not release_msg: # erronous datetime strings - softer message for read-only users
  19                      request.release_msg = _('Error in release information. Please contact site administrator.')

Insertion point 2

   1     def send_page(self, **keywords):
   2 ...
   3         pi = self.pi
   4 
   5 #Additional code goes here.

Additional code 3

   1             # check for and handle unreleased page [IanRiley 01.01.2019]
   2             elif not request.user.may.write(self.page_name) and not release_page:
   3                 special = 'hidden'

Insertion point 3

   1     def send_page(self, **keywords):
   2 ...
   3         if not send_special:
   4             if not page_exists and not body:
   5                 special = 'missing'
   6             elif not request.user.may.read(self.page_name):
   7                 special = 'denied'
   8 
   9 #Additional code goes here.

In the function MoinMoin.page._specialPageText, add the following of code in the position indicated.

Additional code 3

   1         # handle unreleased (hidden) page [IanRiley 01.01.2019]
   2         elif special_type == 'hidden':
   3             page = wikiutil.getLocalizedPage(request, 'HiddenPage')
   4             alternative_text = u"'''%s'''\n\n%s" % (_('Page content not available.'), request.release_msg)

Insertion point 3

   1     def _specialPageText(self, request, special_type):
   2 ...
   3         elif special_type == 'denied':
   4             page = wikiutil.getLocalizedPage(request, 'PermissionDeniedPage')
   5             alternative_text = u"'''%s'''" % _('You are not allowed to view this page.')
   6 
   7 #Additional code goes here.
   8 
   9         else:
  10             assert False

History

Developed with inspiration and MoinMoin code from:

Copyright

License

GNU GPL, see COPYING for details.

Known issues and limitations

None identified.

Hits: 182

PiSchedule