650 lines
20 KiB
C++
Executable File
650 lines
20 KiB
C++
Executable File
/*
|
|
* This file is a part of Winix
|
|
* and is not publicly distributed
|
|
*
|
|
* Copyright (c) 2008-2013, Tomasz Sowa
|
|
* All rights reserved.
|
|
*
|
|
*/
|
|
|
|
#ifndef headerfile_winix_core_config
|
|
#define headerfile_winix_core_config
|
|
|
|
#include <string>
|
|
#include "space/spaceparser.h"
|
|
#include "htmlfilter.h"
|
|
|
|
|
|
|
|
|
|
|
|
class Config
|
|
{
|
|
public:
|
|
|
|
// name of the config file
|
|
// this is the parameter passed to winix programm
|
|
std::string config_file;
|
|
|
|
// start as a demon (in the background)
|
|
// default: true
|
|
bool demonize;
|
|
|
|
// system user name (to which drop privileges)
|
|
// used only if winix is started as the root
|
|
std::string user;
|
|
|
|
// system group name (to which drop privileges)
|
|
// used only if winix is started as the root
|
|
std::string group;
|
|
|
|
// setting additional effective groups from /etc/group
|
|
// by using initgroups()
|
|
// used only if winix is started as the root
|
|
// default: true
|
|
bool additional_groups;
|
|
|
|
// log file name, log file name for notifications (sending emails, etc)
|
|
std::string log_file, log_notify_file;
|
|
|
|
// 1 - minimum
|
|
// 2 - (default)
|
|
// 3 - maximum - all logs
|
|
int log_level;
|
|
|
|
// logging to stdout too
|
|
// only if demonize is 'false'
|
|
// default: false
|
|
bool log_stdout;
|
|
|
|
// how many requests should be saved in the same time
|
|
// default: 1
|
|
int log_request;
|
|
|
|
// whether to save each line of the config (use it for debug purposes)
|
|
// default: false
|
|
bool log_save_each_line;
|
|
|
|
// time zone identifier used in log messages
|
|
// this affects only the first line of logs (where there is IP address, request method etc)
|
|
// see time_zone_default_id below for more info
|
|
// default: 34 (Coordinated Universal Time UTC+00:00)
|
|
size_t log_time_zone_id;
|
|
|
|
// put to log what server is sending back to the client (html/json etc)
|
|
// default: false
|
|
bool log_server_answer;
|
|
|
|
// logging db queries
|
|
// default: false
|
|
bool log_db_query;
|
|
|
|
// logging when a plugin function is called
|
|
// default: false
|
|
bool log_plugin_call;
|
|
|
|
// how many characters in values should be logged from POST parameters
|
|
// default: 80
|
|
// set to 0 to turn off
|
|
size_t log_post_value_size;
|
|
|
|
// request delimiter in the log file, default "---------"
|
|
std::wstring log_delimiter;
|
|
|
|
// fast cgi: socket (unix domain)
|
|
std::string fcgi_socket;
|
|
|
|
// fast cgi: socket permissions
|
|
int fcgi_socket_chmod;
|
|
|
|
// fast cgi: owner of the socket
|
|
std::string fcgi_socket_user;
|
|
|
|
// fast cgi: group of the socket
|
|
std::string fcgi_socket_group;
|
|
|
|
std::wstring templates_dir;
|
|
std::wstring templates_dir_default; // html templates from winix
|
|
|
|
std::wstring txt_templates_dir;
|
|
std::wstring txt_templates_dir_default; // txt (notifications) templates from winix
|
|
|
|
// prefix and postfix for functions templates
|
|
// default:
|
|
// prefix: "fun_"
|
|
// postfix: ".html"
|
|
std::wstring templates_fun_prefix;
|
|
std::wstring templates_fun_postfix;
|
|
|
|
// main html template
|
|
// default: index.html
|
|
std::wstring templates_index;
|
|
|
|
// if true then only root can use 'template' function
|
|
// default: false
|
|
bool template_only_root_use_template_fun;
|
|
|
|
std::string db_database;
|
|
std::string db_user;
|
|
std::string db_pass;
|
|
|
|
std::string http_session_id_name;
|
|
|
|
// string used in a place where is a user (or group) selected
|
|
std::wstring priv_no_user;
|
|
std::wstring priv_no_group;
|
|
|
|
// time in seconds when the user will be automatically logged out (iddle time)
|
|
int session_max_idle;
|
|
|
|
// time in seconds when the user will be automatically logged out (when he selected 'remember me' option)
|
|
// this time is usually greater than session_max_idle
|
|
int session_remember_max_idle;
|
|
|
|
// this file is used when the program is starting and ending
|
|
std::string session_file;
|
|
|
|
// how many sessions can be (zero turn off this checking)
|
|
// default: 1000000 (one milion)
|
|
size_t session_max;
|
|
|
|
// allow the html output to be compressed
|
|
// default: true
|
|
bool compression;
|
|
|
|
// if the output is shorter than this value then it will not be compressed
|
|
// default: 512 bytes
|
|
size_t compression_page_min_size;
|
|
|
|
// 1 - use deflate if available (or raw deflate for Internet Explorer) or don't compress
|
|
// 2 - use gzip if available or don't compress
|
|
// 10 - prefer deflate -- use deflate (or raw deflate for IE) if both deflate and gzip are available
|
|
// 20 - prefer gzip -- use gzip if both deflate and gzip are available
|
|
// default: 20
|
|
int compression_encoding;
|
|
|
|
// plugins directory
|
|
// default: /usr/local/winix/plugins
|
|
std::wstring plugins_dir;
|
|
|
|
// plugins
|
|
// you can provide either a relative path (plugins_dir will be used)
|
|
// or a full path to a plugin
|
|
std::vector<std::wstring> plugin_file;
|
|
|
|
// should the html code be cleaned by the html filter
|
|
bool html_filter;
|
|
|
|
// should white characters be trimmed
|
|
bool html_filter_trim_white;
|
|
|
|
// when long words should be broken (a space will be inserted)
|
|
// default: after 60 non white characters will be put a space
|
|
// set zero to turn off
|
|
size_t html_filter_break_word;
|
|
|
|
// when long lines should be broken (a new line character will be inserted)
|
|
// default: 80
|
|
// set zero to turn off
|
|
size_t html_filter_wrap_line;
|
|
|
|
// how many spaces will be put at one tree level
|
|
// default: 2
|
|
size_t html_filter_tabs;
|
|
|
|
// use checking for 'orphans' for a specicic language
|
|
// default: true
|
|
bool html_filter_orphans;
|
|
|
|
// orphans mode
|
|
// either: "nbsp" or "160"
|
|
// default: "nbsp"
|
|
std::wstring html_filter_orphans_mode_str;
|
|
HTMLFilter::OrphanMode html_filter_orphans_mode;
|
|
|
|
// the url of a new empty item (if there is not the subject too)
|
|
std::wstring item_url_empty;
|
|
|
|
// maximum length of a file send by post multipart form
|
|
// 0 - not used
|
|
size_t post_file_max;
|
|
|
|
// directory for static files
|
|
std::wstring upload_dir;
|
|
|
|
// additional static directories *not* managed by winix
|
|
// you can refer to this directories by using 'static' mount point
|
|
// e.g.
|
|
// let we say in the config you have:
|
|
// static_dirs = ("/home/a", "/home/b", "/home/c")
|
|
// and in /etc/fstab (in winix) you have such a line:
|
|
// "static /my/dir simplefs static(2)"
|
|
// above line in /etc/fstab means that when a user enters http://domain.com/my/dir/file.txt
|
|
// then "file.txt" will be taken from "/home/c/file.txt"
|
|
// this is useful for some javascript files which are protected from running from other domains
|
|
std::vector<std::wstring> static_dirs;
|
|
|
|
// sometimes you can have trouble when you have set an incorrect static path in /etc/fstab
|
|
// in such a case set dont_use_static_dirs to true
|
|
// and winix will behave as there are not any static directories
|
|
// so you can correct your mistake and then set this value to false
|
|
bool dont_use_static_dirs;
|
|
|
|
// static common directory
|
|
// this is a place where there are some common javascripts, images, css files
|
|
// winix is allowed to read some files from there
|
|
// for example ckeditor config, vim config and so on
|
|
// winix read it as a ezc template and put it into database
|
|
// default: empty
|
|
std::wstring common_dir;
|
|
|
|
// chmod of newly created directories (under upload_dir)
|
|
// default: 0750
|
|
int upload_dirs_chmod;
|
|
|
|
// chmod of newly created files (under upload_dir)
|
|
// default: 0640
|
|
int upload_files_chmod;
|
|
|
|
// create a thumbnail from an image
|
|
// default: true
|
|
bool create_thumb;
|
|
|
|
// the mode of creating a thumbnail
|
|
// width means thumb_cx, height means thumb_cy
|
|
// 1: Width given, height automagically selected to preserve aspect ratio.
|
|
// 2: Height given, width automagically selected to preserve aspect ratio.
|
|
// 3: Maximum values of height and width given, aspect ratio preserved.
|
|
// 4: Minimum values of width and height given, aspect ratio preserved.
|
|
// 5: Width and height emphatically given, original aspect ratio ignored.
|
|
// 6: Change as per widthxheight (3) but only if an image dimension exceeds a specified dimension.
|
|
// 7: Change dimensions only if both image dimensions are less than specified dimensions.
|
|
// default: 2
|
|
int thumb_mode;
|
|
|
|
// width of thumbnails
|
|
// default: 150
|
|
size_t thumb_cx;
|
|
|
|
// height of thumbnails
|
|
// default: 150
|
|
size_t thumb_cy;
|
|
|
|
// quality of thumbnails
|
|
// from 0 (the worst) to 100 (the best)
|
|
// more info: http://www.imagemagick.org/script/command-line-options.php?ImageMagick=p4jtel7557hovd34ui3tgb54h6#quality
|
|
// default: 92
|
|
int thumb_quality;
|
|
|
|
// resizing images
|
|
// this not affects thumbnails
|
|
// default: true
|
|
bool image_resize;
|
|
|
|
// the mode of resizing an image
|
|
// the same as 'thumb_mode' above
|
|
// default: 6
|
|
int image_mode;
|
|
|
|
// width of images
|
|
// default: 1000
|
|
size_t image_cx;
|
|
|
|
// height of images
|
|
// default: 800
|
|
size_t image_cy;
|
|
|
|
// quality of an image (the same as in thumbnails)
|
|
// from 0 (the worst) to 100 (the best)
|
|
// default: 92
|
|
int image_quality;
|
|
|
|
// the convert program (ImageMagic) (for images and thumbnails)
|
|
// default: /usr/local/bin/convert
|
|
std::wstring convert_cmd;
|
|
|
|
// directory with locale files
|
|
std::wstring locale_dir;
|
|
|
|
// directory with default locale files (those from winix)
|
|
std::wstring locale_dir_default;
|
|
|
|
// locale files (e.g. "en", "pl")
|
|
// default: only one item: en
|
|
std::vector<std::wstring> locale_files;
|
|
|
|
// a maximum value of a locale identifier
|
|
// default: 100 (maximum: 1000)
|
|
// each locale files should have its own identifier (in "winix_locale_id" field)
|
|
// from zero to this value
|
|
size_t locale_max_id;
|
|
|
|
// locale for not logged users
|
|
// or for newly created accounts
|
|
// default: 0
|
|
size_t locale_default_id;
|
|
|
|
// url protocol
|
|
// default: http://
|
|
std::wstring url_proto;
|
|
|
|
// url protocol when using SSL
|
|
// default: https://
|
|
std::wstring url_ssl_proto;
|
|
|
|
// enables SSL
|
|
// it means this site should be accessed through SSL encrypted connection
|
|
// default: false
|
|
bool use_ssl;
|
|
|
|
// enables SSL for static content
|
|
// used mainly in templates, look at doc_base_url_static ezc function
|
|
// default: false
|
|
bool use_ssl_static;
|
|
|
|
// enables SSL for common content
|
|
// used mainly in templates, look at doc_base_url_common ezc function
|
|
// default: false
|
|
bool use_ssl_common;
|
|
|
|
// if SSL is enabled then if this is true the SSL will be used
|
|
// only for logged users
|
|
// default: true
|
|
bool use_ssl_only_for_logged_users;
|
|
|
|
// if current connection is without SSL and should be made through SSL
|
|
// or if is via SSL and should be done in plain text
|
|
// then we make a redirect
|
|
// default: 303
|
|
int use_ssl_redirect_code;
|
|
|
|
// when the HOST_HTTP environment variable is not equal to 'base_url'
|
|
// (the part 'http://' and the last slash is removed)
|
|
// the server will redirect into base_url + 'REQUEST_URI'
|
|
// it's useful when you want to redirect from 'mydomain.tld' into 'www.mydomain.tld' etc.
|
|
// set this option to false if you have multiple subdomains
|
|
// default: false
|
|
bool base_url_redirect;
|
|
|
|
// the HTTP code used during the base redirect
|
|
// default: 301
|
|
int base_url_redirect_code;
|
|
|
|
// the main address of the site (e.g. www.someserver.com)
|
|
// (without http:// prefix)
|
|
std::wstring base_url;
|
|
|
|
// static content not authorized by winix
|
|
// (e.g. static.someserver.com)
|
|
std::wstring base_url_static;
|
|
|
|
// additional static server for common content (not authorized)
|
|
// (e.g. common.someserver.com)
|
|
std::wstring base_url_common;
|
|
|
|
// separator used in <title> html tag
|
|
std::wstring title_separator;
|
|
|
|
// http header recognized by www server as a file to send back
|
|
// default: X-LIGHTTPD-send-file
|
|
std::wstring http_header_send_file;
|
|
|
|
// prints additional information (in the end of the html page as a commentary)
|
|
bool debug_info;
|
|
|
|
// in editors (emacs, ckeditor,...) the html will be filtered and unsafe tags
|
|
// will be dropped (script, frame, etc.)
|
|
// default: true;
|
|
bool editors_html_safe_mode;
|
|
|
|
// don't filter the html code for root
|
|
// default: true
|
|
// (if true the html code for root is not filtered)
|
|
bool editors_html_safe_mode_skip_root;
|
|
|
|
// charset used in templates, locales, logs etc.
|
|
// default: true (UTF-8)
|
|
// if false it means 8-bit ASCII
|
|
bool utf8;
|
|
|
|
// how many maximum symlinks can be followed
|
|
// (symlinks on directories as well)
|
|
// default: 20
|
|
size_t symlinks_follow_max;
|
|
|
|
// the prefix of a name of html form controls used in the ticket plugin
|
|
// default: ticketparam
|
|
std::wstring ticket_form_prefix;
|
|
|
|
// the minimal size of a user's password
|
|
// default: 5
|
|
size_t pass_min_size;
|
|
|
|
// how passwords should be stored
|
|
// 0 - plain text
|
|
// 1 - md4 hash
|
|
// 2 - md5 hash
|
|
// 10 - sha1 hash
|
|
// 11 - sha224 hash
|
|
// 12 - sha256 hash (default)
|
|
// 13 - sha384 hash
|
|
// 14 - sha512 hash
|
|
int pass_type;
|
|
|
|
// whether the passwords' hashes should be salted or not
|
|
// this affects newly created accounts
|
|
// default: false
|
|
bool pass_hash_use_salt;
|
|
|
|
// salt to a password's hash
|
|
// default empty
|
|
// !! once you set this salt don't change it any more (people wouldn't be allowed to login)
|
|
std::wstring pass_hash_salt;
|
|
|
|
// whether the passwords' hashes should be encrypted
|
|
// this affects newly created accounts
|
|
// default: false
|
|
bool pass_use_rsa;
|
|
|
|
// path to a RSA private key
|
|
// this is actually private + public key in one file
|
|
// generated by "openssl genrsa"
|
|
// default empty which means encryption will not be used
|
|
// !! once you set these keys don't change it any more (people wouldn't be allowed to login)
|
|
std::wstring pass_rsa_private_key;
|
|
|
|
// path to 'openssl'
|
|
// default: /usr/bin/openssl
|
|
std::wstring opensll_path;
|
|
|
|
// setting when we should delete patterns (EZC patterns)
|
|
// we are deleting when we have more (or equal) patterns than 'when_delete'
|
|
// and then we are deleting 'how_many_del' patterns
|
|
// those patterns comes from items (pages) with executable bit set
|
|
size_t pattern_cacher_when_delete;
|
|
size_t pattern_cacher_how_many_delete;
|
|
|
|
// header "Content-Type" send to the client
|
|
// 0 - text/html - for HTML
|
|
// 1 - application/xhtml+xml - for XHTML 1.0
|
|
// 2 - application/xml - for XHTML 1.0 or for XHTML 1.1
|
|
// default: 0
|
|
// if utf8 is true then "; charset=UTF-8" will also be appended
|
|
int content_type_header;
|
|
|
|
// global umask
|
|
// it is used when an user doesn't have your own umask or for guests (not logged users)
|
|
// default: 0222
|
|
int umask;
|
|
|
|
// maximum number for elements through the whole template
|
|
// default: 50000
|
|
size_t ezc_max_elements;
|
|
|
|
// maximum number of each [for] loop
|
|
// default: 5000 (from ezc generator)
|
|
size_t ezc_max_loop_elements;
|
|
|
|
// when true then when a user want to create a new account
|
|
// he has to provide his email and a message will be sent back to him
|
|
// with a link to activate the account
|
|
// default: true
|
|
bool account_need_email_verification;
|
|
|
|
// when a user forgot his password we are able to send an email to him
|
|
// with a link to the page where there is a html form for setting a new password
|
|
// this option tells how long (in seconds) the link is valid
|
|
// default: 86400 (24 hours)
|
|
long reset_password_code_expiration_time;
|
|
|
|
// time zone identifier for not logged users
|
|
// or for newly created accounts
|
|
// those identifiers you can see in etc/time_zones.conf file
|
|
// or by using timezone winix function with 'a' parameter (timezone/a) (!!IMPROVE ME NOT IMPLEMENTED YET)
|
|
// default: 34 (Coordinated Universal Time UTC+00:00)
|
|
size_t time_zone_default_id;
|
|
|
|
// a maximum value of a time zone identifier
|
|
// time zones with an id greater than this will be skipped
|
|
// default: 130 (maximum: 1000)
|
|
size_t time_zone_max_id;
|
|
|
|
// a directory in which there are some config files
|
|
// used mainly when winix starts
|
|
// default: empty (means not for using)
|
|
std::wstring etc_dir;
|
|
|
|
// a file in etc_dir with time zones info
|
|
// default: time_zones.conf
|
|
// this is a Space structure with all time zones
|
|
// with following format:
|
|
// "tz_-12:00" ( # the name of a space is also a key to the locale files
|
|
// tz_offset_str = "-12:00" # a string representing the offset from UTC in a format: [+|-]HH:MM
|
|
// tz_has_dst = "false" # whether the time zone has daylight saving time (bool)
|
|
// tz_dst_offset = "" # offset of the daylight saving time
|
|
// tz_dst_start = "" # when the daylight saving time starts, format: MM:DD HH:MM:SS
|
|
// tz_dst_end = "") # when the daylight saving time ends, format: MM:DD HH:MM:SS
|
|
// each time zone is in a seperate space
|
|
std::wstring time_zones_file;
|
|
|
|
// turn on the IP ban mechanizm
|
|
// we have got three levels of bans (level 1, level 2, and the highest level 3)
|
|
// default: true
|
|
bool use_ban_list;
|
|
|
|
// the so called 'soft' max size
|
|
// read below description for explanation
|
|
// this is introduced to avoid deleting only one record from the ban list
|
|
// default: 50000
|
|
size_t ban_list_soft_max_size;
|
|
|
|
// this is the 'hard' max size of an IP's ban list
|
|
// if there are more records than this value
|
|
// then some of them will be removed (until the size will be ban_list_soft_max_size equal)
|
|
// this value should be a little larger from ban_list_soft_max_size
|
|
// default: 51000
|
|
size_t ban_list_max_size;
|
|
|
|
// delay in seconds of the first level ban
|
|
// default: 1800 (30 minutes)
|
|
// it means withing the next 30 minutes you see only 'you are banned...' message on your webbrowser
|
|
size_t ban_level_1_delay;
|
|
|
|
// delay in seconds of the second level ban
|
|
// default: 86400 (24 hours)
|
|
size_t ban_level_2_delay;
|
|
|
|
// delay in seconds of the third level ban
|
|
// default: 604800 (7 days)
|
|
size_t ban_level_3_delay;
|
|
|
|
// the minimum time in seconds which has to pass between the first GET request
|
|
// (showing your the login form) and the second POST request (which sends the
|
|
// login and password to the server)
|
|
// if the time is shorter then the login attempt is treated as incorrect
|
|
// (the same as if you provide incorrect user/password)
|
|
// default: 2
|
|
size_t incorrect_login_min_time_between_get_post;
|
|
|
|
// how many incorrect logins there must have been passed to display a captcha
|
|
// next to the login form
|
|
// default: 3
|
|
size_t incorrect_login_captcha_treshold;
|
|
|
|
// the way how we prevent to login if there are too many incorrect login attempts
|
|
// 0 - 'block logging' - do not show the login form in 'login' winix function
|
|
// (instead a warning message will be printed)
|
|
// 1 - add to ban list (warning: people from this IP will not be able to see your site and do anything)
|
|
// default: 0
|
|
int incorrect_login_cannot_login_mode;
|
|
|
|
// after how many incorrect login attempts we do the incorrect_login_cannot_login_mode action
|
|
// default: 20
|
|
size_t incorrect_login_cannot_login_treshold;
|
|
|
|
// used when incorrect_login_cannot_login_mode is zero
|
|
// it is the time which should be passed to allow logging
|
|
// default: 1800 (30 minutes)
|
|
// if incorrect_login_cannot_login_mode is one then ban_level_X_delay times
|
|
// will be taken accordingly
|
|
size_t incorrect_login_cannot_login_delay;
|
|
|
|
|
|
|
|
Config();
|
|
bool ReadConfig(bool errors_to_stdout_, bool stdout_is_closed = true);
|
|
|
|
std::wstring & Text(const wchar_t * name);
|
|
std::wstring & Text(const wchar_t * name, const wchar_t * def);
|
|
std::wstring & Text(const std::wstring & name, const wchar_t * def);
|
|
std::string & AText(const wchar_t * name);
|
|
std::string & AText(const wchar_t * name, const char * def);
|
|
std::string & AText(const std::wstring & name, const char * def);
|
|
|
|
int Int(const wchar_t *);
|
|
int Int(const wchar_t * name, int def);
|
|
int Int(const std::wstring & name, int def);
|
|
long Long(const wchar_t *);
|
|
long Long(const wchar_t * name, long def);
|
|
long Long(const std::wstring & name, long def);
|
|
size_t Size(const wchar_t *);
|
|
size_t Size(const wchar_t * name, size_t def);
|
|
size_t Size(const std::wstring & name, size_t def);
|
|
bool Bool(const wchar_t *);
|
|
bool Bool(const wchar_t * name, bool def);
|
|
bool Bool(const std::wstring & name, bool def);
|
|
bool ListText(const wchar_t * name, std::vector<std::wstring> & list);
|
|
bool ListText(const std::wstring & name, std::vector<std::wstring> & list);
|
|
|
|
bool HasValue(const wchar_t * name, const wchar_t * value);
|
|
bool HasValue(const wchar_t * name, const std::wstring & value);
|
|
bool HasValue(const std::wstring & name, const wchar_t * value);
|
|
bool HasValue(const std::wstring & name, const std::wstring & value);
|
|
|
|
// for debug
|
|
void Print(std::wostream & out);
|
|
|
|
// raw access to the config
|
|
PT::Space space;
|
|
|
|
|
|
private:
|
|
|
|
PT::SpaceParser parser;
|
|
std::string default_str;
|
|
bool errors_to_stdout;
|
|
|
|
void ShowError();
|
|
void AssignValues(bool stdout_is_closed);
|
|
void SetAdditionalVariables();
|
|
void CheckPasswd();
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|