#format wiki
#language en
#pragma section-numbers off
#acl IanRiley:read,write,delete,revert,admin All:read

[[RileyLink|{{attachment:RileyLinkFiles/public/[ir].png||align="left",height=35,width=35,target="./RileyLink"}}]]{{attachment:RileyLinkFiles/public/blank.png||align="left",height=35,width=10}}
= 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'''

{{{#!python

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

}}}

'''Insertion position 1'''

{{{#!python

    def parse_processing_instructions(self):
...
        for verb, args in meta:
...
            elif verb == "pragma":
...

#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'''

{{{#!python

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

}}}

'''Insertion point 2'''

{{{#!python

    def send_page(self, **keywords):
...
        pi = self.pi

#Additional code goes here.

}}}

'''Additional code 3 '''

{{{#!python

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

'''Insertion point 3'''

{{{#!python

    def send_page(self, **keywords):
...
        if not send_special:
            if not page_exists and not body:
                special = 'missing'
            elif not request.user.may.read(self.page_name):
                special = 'denied'

#Additional code goes here.

}}}

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

'''Additional code 3 '''

{{{#!python

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

'''Insertion point 3'''

{{{#!python

    def _specialPageText(self, request, special_type):
...
        elif special_type == 'denied':
            page = wikiutil.getLocalizedPage(request, 'PermissionDeniedPage')
            alternative_text = u"'''%s'''" % _('You are not allowed to view this page.')

#Additional code goes here.

        else:
            assert False

}}}

== History ==

Developed with inspiration and MoinMoin code from:

 . @copyright: 2000-2004 by Juergen Hermann <jh@web.de>
 . @copyright: 2005-2008 by MoinMoin:ThomasWaldmann
 . @copyright: 2006 by MoinMoin:FlorianFesti
 . @copyright: 2007 by MoinMoin:ReimarBauer

== Copyright ==

 . @copyright: 2019 Ian Riley <ian@riley.asia>

== License ==

GNU GPL, see COPYING for details.

== Known issues and limitations ==

 * None identified.

-----

 Hits:: <<Hits>>