def app_ctx(cfg):
namespace_mapping, backend_mapping, acl_mapping = create_simple_mapping(
"stores:memory:",
cfg.default_acl
)
more_config = dict(
namespace_mapping=namespace_mapping,
backend_mapping=backend_mapping,
acl_mapping=acl_mapping,
create_storage=True, # create a fresh storage at each app start
destroy_storage=True, # kill all storage contents at app shutdown
create_index=True, # create a fresh index at each app start
destroy_index=True, # kill index contents at app shutdown
)
app = create_app_ext(
flask_config_dict=dict(SECRET_KEY='foobarfoobar'),
moin_config_class=cfg,
**more_config
)
ctx = app.test_request_context('/', base_url="http://localhost:8080/")
ctx.push()
before_wiki()
yield app, ctx
teardown_wiki('')
ctx.pop()
destroy_app(app)
class LocalConfig(Config):
wikiconfig_dir = os.path.abspath(os.path.dirname(__file__))
instance_dir = os.path.join(wikiconfig_dir, 'wiki')
data_dir = os.path.join(instance_dir, 'data')
# sitename is displayed in heading of all wiki pages
sitename = 'My MoinMoin'
# default root, use this to change the name of the default page
# default_root = 'Home' # FrontPage, Main, etc
# options for new user registration
registration_only_by_superuser = True # if email configured, superuser can do > Admin > Register New User
registration_hint = 'To request an account, see bottom of <a href="/Home">Home</a> page.'
# to create a new user without configuring email, use the terminal/command/bash window
# . activate # windows: activate
# moin account-create -n JaneDoe -e [email protected] -p secretpasssword
# allow user self-registration users with email verification; you must configure email to use this
# user_email_verification = True # less secure, web bots may create many unverified accounts with fake email addresses
# to configure email, uncomment line below and choose (a) or (b)
# mail_from = "wiki <*****@*****.**>" # the "from:" address [Unicode]
# (a) using an SMTP server, e.g. "mail.provider.com" with optional `:port`appendix, which defaults to 25 (set None to disable mail)
# mail_smarthost = "smtp.example.org" # 'smtp.gmail.com:587'
# mail_username = "******"
# mail_password = "******"
# (b) an alternative to SMTP may be the sendmail commandline tool:
# mail_sendmail = "/usr/sbin/sendmail -t -i"
# list of admin emails
# admin_emails = ['*****@*****.**']
# send tracebacks to admins
# email_tracebacks = True
# create a super user who will have access to administrative functions
acl_functions = 'JaneDoe,JoeDoe:superuser'
namespace_mapping, backend_mapping, acl_mapping = create_simple_mapping(
uri='stores:fs:{0}/%(backend)s/%(kind)s'.format(data_dir),
default_acl=dict(before='JaneDoe,JoeDoe:read,write,create,destroy,admin',
default='Known:read,write,create,destroy,admin All:read',
after='',
hierarchic=False, ),
users_acl=dict(before='JaneDoe,JoeDoe:read,write,create,destroy,admin',
default='Known:read,write,create,destroy,admin All:read',
after='',
hierarchic=False, ),
# userprofiles contain only metadata, no content will be created
userprofiles_acl=dict(before='All:',
default='',
after='',
hierarchic=False, ),
)
class Config(DefaultConfig):
# We assume this structure for a git clone or simple "unpack and run" scenario:
# moin-2.0/ # wikiconfig_dir points here: clone root or unpack directory, contains this file.
# wikiconfig.py # the file you are reading now.
# wiki/ # instance_dir variable points here: created by running "./m sample" or "./m new-wiki" commands.
# data/ # data_dir variable points here.
# index/ # index_storage variable points here.
# contrib/
# interwiki/
# intermap.txt # interwiki_map variable points here.
# docs/
# _build/
# html/ # serve_files['docs']: html docs made by sphinx, create by running "./m docs" command.
# wiki_local/ # serve_files['wiki_local']: store custom logos, CSS, templates, etc. here
# If that's not true, adjust these paths
wikiconfig_dir = os.path.abspath(os.path.dirname(__file__))
instance_dir = os.path.join(wikiconfig_dir, 'wiki')
data_dir = os.path.join(instance_dir, 'data')
index_storage = 'FileStorage', (os.path.join(instance_dir, "index"), ), {}
# setup static files' serving:
serve_files = dict(
docs=os.path.join(wikiconfig_dir, 'docs', '_build',
'html'), # html docs made by sphinx
wiki_local=os.path.join(
wikiconfig_dir,
'wiki_local'), # store custom logos, CSS, templates, etc. here
)
# copy templates/snippets.html to directory below and edit per requirements to customize logos, etc.
template_dirs = [
os.path.join(wikiconfig_dir, 'wiki_local'),
]
# it is required that you set this to a unique, stable and non-empty name:
interwikiname = u'MyMoinMoin'
# load the interwiki map from intermap.txt:
interwiki_map = InterWikiMap.from_file(
os.path.join(wikiconfig_dir, 'contrib', 'interwiki',
'intermap.txt')).iwmap
# we must add entries for 'Self' and our interwikiname, change these if you are not running the built-in desktop server:
interwiki_map[interwikiname] = 'http://127.0.0.1:8080/'
interwiki_map['Self'] = 'http://127.0.0.1:8080/'
# sitename is displayed in heading of all wiki pages
sitename = u'My MoinMoin'
# default theme is topside
# theme_default = u"modernized" # or basic or topside_cms
# read about PRIVACY ISSUES in docs before uncommenting the line below to use gravatars
# user_use_gravatar = True
# read about SECURITY ISSUES in docs before uncommenting the line below allowing users
# to edit style attributes in HTML and Markdown items
# allow_style_attributes = True
# default passwords are required to be => 8 characters with minimum of 5 unique characters
# password_checker = None # no password length or quality checking
# password_checker = lambda cfg, name, pw: _default_password_checker(cfg, name, pw, min_length=8, min_different=5) # default
# optional, configure email, uncomment line below and choose (a) or (b)
# mail_from = u"wiki <*****@*****.**>" # the "from:" address [Unicode]
# (a) using an SMTP server, e.g. "mail.provider.com" with optional `:port`appendix, which defaults to 25 (set None to disable mail)
# mail_smarthost = "smtp.example.org"
# mail_username = "******" # if you need to use SMTP AUTH at your mail_smarthost:
# mail_password = "******"
# (b) an alternative to SMTP is the sendmail commandline tool:
# mail_sendmail = "/usr/sbin/sendmail -t -i"
# list of admin emails
admin_emails = []
# send tracebacks to admins
email_tracebacks = False
# add or remove packages - see https://bitbucket.org/thomaswaldmann/xstatic for info about xstatic
# it is uncommon to change these because of local customizations
from xstatic.main import XStatic
# names below must be package names
mod_names = [
'jquery',
'jquery_file_upload',
'bootstrap',
'font_awesome',
'ckeditor',
'autosize',
'svgedit_moin',
'twikidraw_moin',
'anywikidraw',
'jquery_tablesorter',
'pygments',
]
pkg = __import__('xstatic.pkg', fromlist=mod_names)
for mod_name in mod_names:
mod = getattr(pkg, mod_name)
xs = XStatic(mod,
root_url='/static',
provider='local',
protocol='http')
serve_files[xs.name] = xs.base_dir
# create a super user who will have access to administrative functions
# acl_functions = u'+YourName:superuser'
# OR, create several WikiGroups and create several superusers
# SuperGroup and TrustedEditorGroup reference WikiGroups you must create
# acl_functions = u'+YourName:superuser SuperGroup:superuser'
# This provides a simple default setup for your backend configuration.
# 'stores:fs:...' indicates that you want to use the filesystem backend.
# Alternatively you can set up the mapping yourself (see HelpOnStorageConfiguration).
namespace_mapping, backend_mapping, acl_mapping = create_simple_mapping(
uri='stores:fs:{0}/%(backend)s/%(kind)s'.format(data_dir),
# XXX we use rather relaxed ACLs for the development wiki:
default_acl=dict(
before=u'',
default=u'All:read,write,create,destroy,admin',
after=u'',
hierarchic=False,
),
users_acl=dict(
before=u'',
default=u'All:read,write,create,destroy,admin',
after=u'',
hierarchic=False,
),
# userprofiles contain only metadata, no content will be created
userprofiles_acl=dict(
before=u'All:',
default=u'',
after=u'',
hierarchic=False,
),
)
"""
class Config(DefaultConfig):
"""
We assume this structure for a git clone scenario used by developers:
moin/ # clone root and wikiconfig dir, use this as CWD for ./m or moin commands
contrib # developer tools
docs/
_build/
html/ # local copy of moin documentation, created by running "./m docs" command
src/
moin/ # directory containing moin application code
wiki/ # the wiki instance; created by running "./m sample" or "./m new-wiki" commands
data/ # wiki data and metadata
index/ # wiki indexes
preview/ # edit backups created when user clicks edit Preview button
sql/ # sql database used for edit locking
wikiconfig.py # main configuration file, modify this to add or change features
wiki_local/ # use this to store custom CSS, Javascript, templates, logos, etc.
intermap.txt # list of external wikis used in wikilinks: [[MeatBall:InterWiki]]
<moin-venv-python> # virtual env is created as a sibling to moin/ by default
bin/ # Windows calls this directory Scripts
include # Windows calls this directory Include
lib/ # Windows calls this directory Lib
OR: To install moin from pypi into a venv, enter this sequence of commands:
<python> -m venv <myvenv>
cd <path-to-new-myvenv>
source bin/activate activate # Scripts\activate.bat
pip install wheel
pip install moin
moin create-instance --path <mywiki>
cd <mywiki>
moin index-create -s -i # creates empty wiki, OR
moin import19 -s -i --data_dir <path to 1.9 wiki/data> # import 1.9 data, OR
moin index-create; moin load-sample; moin index-build # creates wiki with sample data
to create this structure:
<myvenv>/ # virtualenv root, moin installed in site-packages below include/
bin/ # Windows calls this directory Scripts
include/ # Windows calls this directory Include
lib/ # Windows calls this directory Lib
<mywiki>/ # wikiconfig dir, use this as CWD for moin commands after <myvenv> activated
wiki/ # the wiki instance; created by `moin create-instance`
data/ # wiki data and metadata
index/ # wiki indexes
preview/ # backups created when user clicks edit Preview button
sql/ # sqlite database used for edit locking
wiki-local/ # store custom CSS, Javascript, templates, logos, etc. here
wikiconfig.py # main configuration file, modify this to add or change features
intermap.txt # list of external wikis used in wikilinks: [[MeatBall:InterWiki]]
If that's not true, adjust these paths
"""
wikiconfig_dir = os.path.abspath(os.path.dirname(__file__))
instance_dir = os.path.join(wikiconfig_dir, 'wiki')
data_dir = os.path.join(instance_dir, 'data')
index_storage = 'FileStorage', (os.path.join(instance_dir, "index"), ), {}
# setup static files' serving:
serve_files = dict(
wiki_local=os.path.join(
wikiconfig_dir,
'wiki_local'), # store custom logos, CSS, templates, etc. here
)
docs = os.path.join(wikiconfig_dir, 'docs', '_build', 'html')
if os.path.isdir(docs):
serve_files['docs'] = docs
else:
# change target if a specific release or language is available
serve_files[
'external_docs'] = "https://moin-20.readthedocs.io/en/latest/"
# copy templates/snippets.html to directory below and edit per requirements to customize logos, etc.
template_dirs = [
os.path.join(wikiconfig_dir, 'wiki_local'),
]
# it is required that you set interwikiname to a unique, stable and non-empty name.
# Changing interwikiname on an existing wiki requires rebuilding the index.
interwikiname = 'MyMoinMoin'
# load the interwiki map from intermap.txt
try:
interwiki_map = InterWikiMap.from_file(
os.path.join(wikiconfig_dir, 'intermap.txt')).iwmap
except FileNotFoundError:
interwiki_map = {}
# we must add entries for 'Self' and our interwikiname,
# if you are not running the built-in desktop server change these to your wiki URL
interwiki_map[interwikiname] = 'http://127.0.0.1:8080/'
interwiki_map['Self'] = 'http://127.0.0.1:8080/'
# sitename is displayed in heading of all wiki pages
sitename = 'My MoinMoin'
# default theme is topside
# theme_default = "modernized" # or basic or topside_cms
# read about PRIVACY ISSUES in docs before uncommenting the line below to use gravatars
# user_use_gravatar = True
# read about SECURITY ISSUES in docs before uncommenting the line below allowing users
# to edit style attributes in HTML and Markdown items
# allow_style_attributes = True
# default passwords are required to be => 8 characters with minimum of 5 unique characters
# password_checker = None # no password length or quality checking
# password_checker = lambda cfg, name, pw: _default_password_checker(cfg, name, pw, min_length=8, min_different=5) # default
# optional, configure email, uncomment line below and choose (a) or (b)
# mail_from = "wiki <*****@*****.**>" # the "from:" address [Unicode]
# (a) using an SMTP server, e.g. "mail.provider.com" with optional `:port`appendix, which defaults to 25 (set None to disable mail)
# mail_smarthost = "smtp.example.org"
# mail_username = "******" # if you need to use SMTP AUTH at your mail_smarthost:
# mail_password = "******"
# (b) an alternative to SMTP is the sendmail commandline tool:
# mail_sendmail = "/usr/sbin/sendmail -t -i"
# list of admin emails
admin_emails = []
# send tracebacks to admins
email_tracebacks = False
# options for new user registration
# registration_only_by_superuser = True # disables self-registration, recommended for public wikis on internet
# registration_hint = 'To request an account, see bottom of <a href="/Home">Home</a> page.'
# add or remove packages - see https://bitbucket.org/thomaswaldmann/xstatic for info about xstatic
# it is uncommon to change these because of local customizations
from xstatic.main import XStatic
# names below must be package names
mod_names = [
'jquery',
'jquery_file_upload',
'bootstrap',
'font_awesome',
'ckeditor',
'autosize',
'svgedit_moin',
'twikidraw_moin',
'anywikidraw',
'jquery_tablesorter',
'pygments',
]
pkg = __import__('xstatic.pkg', fromlist=mod_names)
for mod_name in mod_names:
mod = getattr(pkg, mod_name)
xs = XStatic(mod,
root_url='/static',
provider='local',
protocol='http')
serve_files[xs.name] = xs.base_dir
# create a super user who will have access to administrative functions
# acl_functions = '+YourName:superuser'
# OR, create several WikiGroups and create several superusers
# SuperGroup and TrustedEditorGroup reference WikiGroups you must create
# acl_functions = '+YourName:superuser SuperGroup:superuser'
# This provides a simple default setup for your backend configuration.
# 'stores:fs:...' indicates that you want to use the filesystem backend.
# Alternatively you can set up the mapping yourself (see HelpOnStorageConfiguration).
namespace_mapping, backend_mapping, acl_mapping = create_simple_mapping(
uri='stores:fs:{0}/%(backend)s/%(kind)s'.format(data_dir),
# XXX we use rather relaxed ACLs for the development wiki:
default_acl=dict(
before='',
default='All:read,write,create,destroy,admin',
after='',
hierarchic=False,
),
users_acl=dict(
before='',
default='All:read,write,create,destroy,admin',
after='',
hierarchic=False,
),
# userprofiles contain only metadata, no content will be created
userprofiles_acl=dict(
before='All:',
default='',
after='',
hierarchic=False,
),
help_common_acl=dict(
before='',
default='All:read,write,create,destroy',
after='',
hierarchic=False,
),
help_en_acl=dict(
before='',
default='All:read,write,create,destroy',
after='',
hierarchic=False,
),
)
"""