# coding: utf-8

#

# Copyright 2014 The Oppia Authors. All Rights Reserved.

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS-IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

"""Stores various configuration options and constants for Oppia."""

import copy

import datetime

import os

# Whether to unconditionally log info messages.

DEBUG = False

# The platform for the storage backend. This is used in the model-switching

# code in core/platform.

PLATFORM = 'gae'

# This should be string comparison, since all environment variables

# are converted to string

IS_MINIFIED = os.environ.get('MINIFICATION') == 'True'

# Whether we should serve the development or production experience.

# DEV_MODE should only be changed to False in the production environment.

# To use minified resources in the development environment,

# change the MINIFICATION env variable in app.yaml to True.

# When DEV_MODE is True, this indicates that we are not running in

# the production App Engine environment, which affects things like

# login/logout URLs,as well as third-party libraries

# that App Engine normally provides.

# os.environ['SERVER_SOFTWARE'] = "Product"

if PLATFORM == 'gae':

DEV_MODE = (

not os.environ.get('SERVER_SOFTWARE')

or os.environ['SERVER_SOFTWARE'].startswith('Development'))

else:

raise Exception('Invalid platform: expected one of [\'gae\']')

CLASSIFIERS_DIR = os.path.join('extensions', 'classifiers')

TESTS_DATA_DIR = os.path.join('core', 'tests', 'data')

SAMPLE_EXPLORATIONS_DIR = os.path.join('data', 'explorations')

SAMPLE_COLLECTIONS_DIR = os.path.join('data', 'collections')

INTERACTIONS_DIR = os.path.join('extensions', 'interactions')

GADGETS_DIR = os.path.join('extensions', 'gadgets')

RTE_EXTENSIONS_DIR = os.path.join('extensions', 'rich_text_components')

OBJECT_TEMPLATES_DIR = os.path.join('extensions', 'objects', 'templates')

# Choose production template if minification flag is used or

# if in production mode

TEMPLATES_DIR_PREFIX = 'prod' if (IS_MINIFIED or not DEV_MODE) else 'dev'

FRONTEND_TEMPLATES_DIR = os.path.join(

'core', 'templates', TEMPLATES_DIR_PREFIX, 'head')

DEPENDENCIES_TEMPLATES_DIR = os.path.join('extensions', 'dependencies')

VALUE_GENERATORS_DIR = os.path.join('extensions', 'value_generators')

VISUALIZATIONS_DIR = os.path.join('extensions', 'visualizations')

OBJECT_DEFAULT_VALUES_FILE_PATH = os.path.join(

'extensions', 'interactions', 'object_defaults.json')

RULES_DESCRIPTIONS_FILE_PATH = os.path.join(

os.getcwd(), 'extensions', 'interactions', 'rule_templates.json')

# A mapping of interaction ids to their default classifier.

INTERACTION_CLASSIFIER_MAPPING = {

'TextInput': {

'algorithm_id': 'LDAStringClassifier',

'current_data_schema_version': 1

}

}

TRAINING_JOB_STATUS_COMPLETE = 'COMPLETE'

TRAINING_JOB_STATUS_FAILED = 'FAILED'

TRAINING_JOB_STATUS_NEW = 'NEW'

TRAINING_JOB_STATUS_PENDING = 'PENDING'

ALLOWED_TRAINING_JOB_STATUSES = [

TRAINING_JOB_STATUS_COMPLETE,

TRAINING_JOB_STATUS_FAILED,

TRAINING_JOB_STATUS_NEW,

TRAINING_JOB_STATUS_PENDING

]

# The minimum number of training samples required for training a classifier.

MIN_TOTAL_TRAINING_EXAMPLES = 50

# The minimum number of assigned labels required for training a classifier.

MIN_ASSIGNED_LABELS = 2

# Default label for classification algorithms.

DEFAULT_CLASSIFIER_LABEL = '_default'

# The maximum number of results to retrieve in a datastore query.

DEFAULT_QUERY_LIMIT = 1000

# The maximum number of results to retrieve in a datastore query

# for top rated published explorations in /library page.

NUMBER_OF_TOP_RATED_EXPLORATIONS_FOR_LIBRARY_PAGE = 8

# The maximum number of results to retrieve in a datastore query

# for recently published explorations in /library page.

RECENTLY_PUBLISHED_QUERY_LIMIT_FOR_LIBRARY_PAGE = 8

# The maximum number of results to retrieve in a datastore query

# for top rated published explorations in /library/top_rated page.

NUMBER_OF_TOP_RATED_EXPLORATIONS_FULL_PAGE = 20

# The maximum number of results to retrieve in a datastore query

# for recently published explorations in /library/recently_published page.

RECENTLY_PUBLISHED_QUERY_LIMIT_FULL_PAGE = 20

# The current version of the dashboard stats blob schema. If any backward-

# incompatible changes are made to the stats blob schema in the data store,

# this version number must be changed.

CURRENT_DASHBOARD_STATS_SCHEMA_VERSION = 1

# The current version of the exploration states blob schema. If any backward-

# incompatible changes are made to the states blob schema in the data store,

# this version number must be changed and the exploration migration job

# executed.

CURRENT_EXPLORATION_STATES_SCHEMA_VERSION = 9

# The current version of the all collection blob schemas (such as the nodes

# structure within the Collection domain object). If any backward-incompatible

# changes are made to any of the blob schemas in the data store, this version

# number must be changed.

CURRENT_COLLECTION_SCHEMA_VERSION = 3

# This value should be updated in the event of any

# StateAnswersModel.submitted_answer_list schema change.

CURRENT_STATE_ANSWERS_SCHEMA_VERSION = 1

# The default number of exploration tiles to load at a time in the search

# results page.

SEARCH_RESULTS_PAGE_SIZE = 20

# The default number of commits to show on a page in the exploration history

# tab.

COMMIT_LIST_PAGE_SIZE = 50

# The default number of items to show on a page in the exploration feedback

# tab.

FEEDBACK_TAB_PAGE_SIZE = 20

# Default title for a newly-minted exploration.

DEFAULT_EXPLORATION_TITLE = ''

# Default category for a newly-minted exploration.

DEFAULT_EXPLORATION_CATEGORY = ''

# Default objective for a newly-minted exploration.

DEFAULT_EXPLORATION_OBJECTIVE = ''

# Default name for the initial state of an exploration.

DEFAULT_INIT_STATE_NAME = 'Introduction'

# The default content text for the initial state of an exploration.

DEFAULT_INIT_STATE_CONTENT_STR = ''

# Default title for a newly-minted collection.

DEFAULT_COLLECTION_TITLE = ''

# Default category for a newly-minted collection.

DEFAULT_COLLECTION_CATEGORY = ''

# Default objective for a newly-minted collection.

DEFAULT_COLLECTION_OBJECTIVE = ''

# Default ID of VM which is used for training classifier.

DEFAULT_VM_ID = 'vm_default'

# Shared secret key for default VM.

DEFAULT_VM_SHARED_SECRET = '1a2b3c4e'

# A dict containing the accepted image formats (as determined by the imghdr

# module) and the corresponding allowed extensions in the filenames of uploaded

# files.

ACCEPTED_IMAGE_FORMATS_AND_EXTENSIONS = {

'jpeg': ['jpg', 'jpeg'],

'png': ['png'],

'gif': ['gif']

}

# A string containing the disallowed characters in state or exploration names.

# The underscore is needed because spaces in names must be converted to

# underscores when displayed as part of a URL or key. The other conventions

# here are derived from the Wikipedia guidelines for naming articles.

INVALID_NAME_CHARS = u':#/|_%<>[]{}\ufffd\\' + chr(127)

for ind in range(32):

INVALID_NAME_CHARS += chr(ind)

# Prefix for data sent from the server to the client via JSON.

XSSI_PREFIX = ')]}\'\n'

# A regular expression for alphanumeric characters.

ALPHANUMERIC_REGEX = r'^[A-Za-z0-9]+$'

# A regular expression for alphanumeric words separated by single spaces.

# Ex.: 'valid name', 'another valid name', 'invalid name'.

ALPHANUMERIC_SPACE_REGEX = r'^[0-9A-Za-z]+(?:[ ]?[0-9A-Za-z]+)*$'

# A regular expression for tags.

TAG_REGEX = r'^[a-z ]+$'

# Invalid names for parameters used in expressions.

AUTOMATICALLY_SET_PARAMETER_NAMES = ['answer', 'choices']

INVALID_PARAMETER_NAMES = AUTOMATICALLY_SET_PARAMETER_NAMES + [

'abs', 'all', 'and', 'any', 'else', 'floor', 'if', 'log', 'or',

'pow', 'round', 'then']

# These are here rather than in rating_services.py to avoid import

# circularities with exp_services.

# TODO (Jacob) Refactor exp_services to remove this problem.

_EMPTY_RATINGS = {'1': 0, '2': 0, '3': 0, '4': 0, '5': 0}

def get_empty_ratings():

return copy.deepcopy(_EMPTY_RATINGS)

# Empty scaled average rating as a float.

EMPTY_SCALED_AVERAGE_RATING = 0.0

# To use GAE email service.

EMAIL_SERVICE_PROVIDER_GAE = 'gae_email_service'

# To use mailgun email service.

EMAIL_SERVICE_PROVIDER_MAILGUN = 'mailgun_email_service'

# Use GAE email service by default.

EMAIL_SERVICE_PROVIDER = EMAIL_SERVICE_PROVIDER_GAE

# If the Mailgun email API is used, the "None" below should be replaced

# with the Mailgun API key.

MAILGUN_API_KEY = None

# If the Mailgun email API is used, the "None" below should be replaced

# with the Mailgun domain name (ending with mailgun.org).

MAILGUN_DOMAIN_NAME = None

# Domain name for email address.

INCOMING_EMAILS_DOMAIN_NAME = 'example.com'

# Committer id for system actions.

SYSTEM_COMMITTER_ID = 'admin'

SYSTEM_EMAIL_ADDRESS = 'system@example.com'

ADMIN_EMAIL_ADDRESS = 'testadmin@example.com'

NOREPLY_EMAIL_ADDRESS = 'noreply@example.com'

# Ensure that SYSTEM_EMAIL_ADDRESS and ADMIN_EMAIL_ADDRESS are both valid and

# correspond to owners of the app before setting this to True. If

# SYSTEM_EMAIL_ADDRESS is not that of an app owner, email messages from this

# address cannot be sent. If True then emails can be sent to any user.

CAN_SEND_EMAILS = False

# If you want to turn on this facility please check the email templates in the

# send_role_notification_email() function in email_manager.py and modify them

# accordingly.

CAN_SEND_EDITOR_ROLE_EMAILS = False

# If enabled then emails will be sent to creators for feedback messages.

CAN_SEND_FEEDBACK_MESSAGE_EMAILS = False

# If enabled subscription emails will be sent to that user.

CAN_SEND_SUBSCRIPTION_EMAILS = False

# Time to wait before sending feedback message emails (currently set to 1

# hour).

DEFAULT_FEEDBACK_MESSAGE_EMAIL_COUNTDOWN_SECS = 3600

# Whether to send an email when new feedback message is received for

# an exploration.

DEFAULT_FEEDBACK_MESSAGE_EMAIL_PREFERENCE = True

# Whether to send an email to all the creator's subscribers when he/she

# publishes an exploration.

DEFAULT_SUBSCRIPTION_EMAIL_PREFERENCE = True

# Whether exploration feedback emails are muted,

# when the user has not specified a preference.

DEFAULT_FEEDBACK_NOTIFICATIONS_MUTED_PREFERENCE = False

# Whether exploration suggestion emails are muted,

# when the user has not specified a preference.

DEFAULT_SUGGESTION_NOTIFICATIONS_MUTED_PREFERENCE = False

# Whether to send email updates to a user who has not specified a preference.

DEFAULT_EMAIL_UPDATES_PREFERENCE = False

# Whether to send an invitation email when the user is granted

# new role permissions in an exploration.

DEFAULT_EDITOR_ROLE_EMAIL_PREFERENCE = True

# Whether to require an email to be sent, following a moderator action.

REQUIRE_EMAIL_ON_MODERATOR_ACTION = False

# Whether to allow custom event reporting to Google Analytics.

CAN_SEND_ANALYTICS_EVENTS = False

# Timespan in minutes before allowing duplicate emails.

DUPLICATE_EMAIL_INTERVAL_MINS = 2

# Number of digits after decimal to which the average ratings value in the

# dashboard is rounded off to.

AVERAGE_RATINGS_DASHBOARD_PRECISION = 2

# Whether to enable the promo bar functionality. This does not actually turn on

# the promo bar, as that is gated by a config value (see config_domain). This

# merely avoids checking for whether the promo bar is enabled for every Oppia

# page visited.

ENABLE_PROMO_BAR = True

# Whether to enable maintenance mode on the site. For non-admins, this redirects

# all HTTP requests to the maintenance page. This is the only check which

# determines whether the site is in maintenance mode to avoid queries to the

# database by non-admins.

ENABLE_MAINTENANCE_MODE = False

EMAIL_INTENT_SIGNUP = 'signup'

EMAIL_INTENT_DAILY_BATCH = 'daily_batch'

EMAIL_INTENT_EDITOR_ROLE_NOTIFICATION = 'editor_role_notification'

EMAIL_INTENT_FEEDBACK_MESSAGE_NOTIFICATION = 'feedback_message_notification'

EMAIL_INTENT_SUBSCRIPTION_NOTIFICATION = 'subscription_notification'

EMAIL_INTENT_SUGGESTION_NOTIFICATION = 'suggestion_notification'

EMAIL_INTENT_REPORT_BAD_CONTENT = 'report_bad_content'

EMAIL_INTENT_MARKETING = 'marketing'

EMAIL_INTENT_PUBLICIZE_EXPLORATION = 'publicize_exploration'

EMAIL_INTENT_UNPUBLISH_EXPLORATION = 'unpublish_exploration'

EMAIL_INTENT_DELETE_EXPLORATION = 'delete_exploration'

EMAIL_INTENT_QUERY_STATUS_NOTIFICATION = 'query_status_notification'

# Possible intents for email sent in bulk.

BULK_EMAIL_INTENT_MARKETING = 'bulk_email_marketing'

BULK_EMAIL_INTENT_IMPROVE_EXPLORATION = 'bulk_email_improve_exploration'

BULK_EMAIL_INTENT_CREATE_EXPLORATION = 'bulk_email_create_exploration'

BULK_EMAIL_INTENT_CREATOR_REENGAGEMENT = 'bulk_email_creator_reengagement'

BULK_EMAIL_INTENT_LEARNER_REENGAGEMENT = 'bulk_email_learner_reengagement'

BULK_EMAIL_INTENT_TEST = 'bulk_email_test'

MESSAGE_TYPE_FEEDBACK = 'feedback'

MESSAGE_TYPE_SUGGESTION = 'suggestion'

MODERATOR_ACTION_PUBLICIZE_EXPLORATION = 'publicize_exploration'

MODERATOR_ACTION_UNPUBLISH_EXPLORATION = 'unpublish_exploration'

DEFAULT_SALUTATION_HTML_FN = (

lambda recipient_username: 'Hi %s,' % recipient_username)

DEFAULT_SIGNOFF_HTML_FN = (

lambda sender_username: (

'Thanks!<br>%s (Oppia moderator)' % sender_username))

VALID_MODERATOR_ACTIONS = {

MODERATOR_ACTION_PUBLICIZE_EXPLORATION: {

'email_config': 'publicize_exploration_email_html_body',

'email_subject_fn': (

lambda exp_title: (

'Your Oppia exploration "%s" has been featured!' % exp_title)),

'email_intent': EMAIL_INTENT_PUBLICIZE_EXPLORATION,

'email_salutation_html_fn': DEFAULT_SALUTATION_HTML_FN,

'email_signoff_html_fn': DEFAULT_SIGNOFF_HTML_FN,

},

MODERATOR_ACTION_UNPUBLISH_EXPLORATION: {

'email_config': 'unpublish_exploration_email_html_body',

'email_subject_fn': (

lambda exp_title: (

'Your Oppia exploration "%s" has been unpublished' % exp_title)

),

'email_intent': 'unpublish_exploration',

'email_salutation_html_fn': DEFAULT_SALUTATION_HTML_FN,

'email_signoff_html_fn': DEFAULT_SIGNOFF_HTML_FN,

},

}

# Panel properties and other constants for the default skin.

GADGET_PANEL_AXIS_HORIZONTAL = 'horizontal'

PANELS_PROPERTIES = {

'bottom': {

'width': 350,

'height': 100,

'stackable_axis': GADGET_PANEL_AXIS_HORIZONTAL,

'pixels_between_gadgets': 80,

'max_gadgets': 1

}

}

# When the site terms were last updated, in UTC.

REGISTRATION_PAGE_LAST_UPDATED_UTC = datetime.datetime(2015, 10, 14, 2, 40, 0)

# Format of string for dashboard statistics logs.

# NOTE TO DEVELOPERS: This format should not be changed, since it is used in

# the existing storage models for UserStatsModel.

DASHBOARD_STATS_DATETIME_STRING_FORMAT = '%Y-%m-%d'

# The maximum size of an uploaded file, in bytes.

MAX_FILE_SIZE_BYTES = 1048576

# The default language code for an exploration.

DEFAULT_LANGUAGE_CODE = 'zh'

# The id of the default skin.

# TODO(sll): Deprecate this; it is no longer used.

DEFAULT_SKIN_ID = 'conversation_v1'

# The prefix for an 'accepted suggestion' commit message.

COMMIT_MESSAGE_ACCEPTED_SUGGESTION_PREFIX = 'Accepted suggestion by'

# User id and username for exploration migration bot. Commits made by this bot

# are not reflected in the exploration summary models, but are recorded in the

# exploration commit log.

MIGRATION_BOT_USER_ID = 'OppiaMigrationBot'

MIGRATION_BOT_USERNAME = 'OppiaMigrationBot'

# Ids and locations of the permitted extensions.

ALLOWED_RTE_EXTENSIONS = {

'Collapsible': {

'dir': os.path.join(RTE_EXTENSIONS_DIR, 'Collapsible')

},

'Image': {

'dir': os.path.join(RTE_EXTENSIONS_DIR, 'Image')

},

'Link': {

'dir': os.path.join(RTE_EXTENSIONS_DIR, 'Link')

},

'Math': {

'dir': os.path.join(RTE_EXTENSIONS_DIR, 'Math')

},

'Tabs': {

'dir': os.path.join(RTE_EXTENSIONS_DIR, 'Tabs')

},

'Video': {

'dir': os.path.join(RTE_EXTENSIONS_DIR, 'Video')

},

}

# This list contains the IDs of the classifiers used for obtaining instances

# class of classifiers using classifier_registry.

ANSWER_CLASSIFIER_CLASS_IDS = [

'LDAStringClassifier',

]

# These categories and interactions are displayed in the order in which they

# appear in the interaction selector.

ALLOWED_INTERACTION_CATEGORIES = [{

'name': 'General',

'interaction_ids': [

'Continue',

'EndExploration',

'ImageClickInput',

'ItemSelectionInput',

'MultipleChoiceInput',

'TextInput'

],

}, {

'name': 'Math',

'interaction_ids': [

'GraphInput',

'LogicProof',

'NumericInput',

'SetInput',

'MathExpressionInput',

]

}, {

'name': 'Programming',

'interaction_ids': [

'CodeRepl',

'PencilCodeEditor',

],

}, {

'name': 'Music',

'interaction_ids': [

'MusicNotesInput'

],

}, {

'name': 'Geography',

'interaction_ids': [

'InteractiveMap'

],

}]

# The list of interaction IDs which correspond to interactions that set their

# is_linear property to true. Linear interactions do not support branching and

# thus only allow for default answer classification. This value is guarded by a

# test in extensions.interactions.base_test.

LINEAR_INTERACTION_IDS = ['Continue']

ALLOWED_GADGETS = {

'ScoreBar': {

'dir': os.path.join(GADGETS_DIR, 'ScoreBar')

},

}

# Gadgets subclasses must specify a valid panel option from this list.

ALLOWED_GADGET_PANELS = ['bottom']

# Demo explorations to load through the admin panel. The id assigned to each

# exploration is based on the key of the exploration in this dict, so ensure it

# doesn't change once it's in the list. Only integer-based indices should be

# used in this list, as it maintains backward compatibility with how demo

# explorations used to be assigned IDs. The value of each entry in this dict is

# either a YAML file or a directory (depending on whether it ends in .yaml).

# These explorations can be found under data/explorations.

DEMO_EXPLORATIONS = {

u'0': 'welcome.yaml',

u'1': 'multiples.yaml',

u'2': 'binary_search',

u'3': 'root_linear_coefficient_theorem.yaml',

u'4': 'three_balls',

# TODO(bhenning): Replace demo exploration '5' with a new exploration

# described in #1376.

u'6': 'boot_verbs.yaml',

u'7': 'hola.yaml',

u'8': 'adventure.yaml',

u'9': 'pitch_perfect.yaml',

u'10': 'test_interactions',

u'11': 'modeling_graphs',

u'12': 'protractor_test_1.yaml',

u'13': 'solar_system',

u'14': 'about_oppia.yaml',

u'15': 'classifier_demo_exploration.yaml',

u'16': 'all_interactions',

}

DEMO_COLLECTIONS = {

u'0': 'welcome_to_collections.yaml'

}

# IDs of explorations which should not be displayable in either the learner or

# editor views.

DISABLED_EXPLORATION_IDS = ['5']

# Google Group embed URL for the Forum page.

EMBEDDED_GOOGLE_GROUP_URL = (

'https://groups.google.com/forum/embed/?place=forum/oppia')

# Whether to allow YAML file uploads.

ALLOW_YAML_FILE_UPLOAD = False

# Prefix for all taskqueue-related URLs.

TASKQUEUE_URL_PREFIX = '/task'

TASK_URL_FEEDBACK_MESSAGE_EMAILS = (

'%s/email/batchfeedbackmessageemailhandler' % TASKQUEUE_URL_PREFIX)

TASK_URL_FEEDBACK_STATUS_EMAILS = (

'%s/email/feedbackthreadstatuschangeemailhandler' % TASKQUEUE_URL_PREFIX)

TASK_URL_FLAG_EXPLORATION_EMAILS = (

'%s/email/flagexplorationemailhandler' % TASKQUEUE_URL_PREFIX)

TASK_URL_INSTANT_FEEDBACK_EMAILS = (

'%s/email/instantfeedbackmessageemailhandler' % TASKQUEUE_URL_PREFIX)

TASK_URL_SUGGESTION_EMAILS = (

'%s/email/suggestionemailhandler' % TASKQUEUE_URL_PREFIX)

# TODO(sll): Add all other URLs here.

ADMIN_URL = '/admin'

COLLECTION_DATA_URL_PREFIX = '/collection_handler/data'

COLLECTION_SUMMARIES_DATA_URL = '/collectionsummarieshandler/data'

EDITABLE_COLLECTION_DATA_URL_PREFIX = '/collection_editor_handler/data'

COLLECTION_RIGHTS_PREFIX = '/collection_editor_handler/rights'

COLLECTION_EDITOR_URL_PREFIX = '/collection_editor/create'

COLLECTION_URL_PREFIX = '/collection'

CREATOR_DASHBOARD_URL = '/creator_dashboard'

DASHBOARD_CREATE_MODE_URL = '%s?mode=create' % CREATOR_DASHBOARD_URL

CREATOR_DASHBOARD_DATA_URL = '/creatordashboardhandler/data'

DASHBOARD_EXPLORATION_STATS_PREFIX = '/creatordashboardhandler/explorationstats'

EDITOR_URL_PREFIX = '/create'

EXPLORATION_DATA_PREFIX = '/createhandler/data'

EXPLORATION_INIT_URL_PREFIX = '/explorehandler/init'

EXPLORATION_METADATA_SEARCH_URL = '/exploration/metadata_search'

EXPLORATION_RIGHTS_PREFIX = '/createhandler/rights'

EXPLORATION_SUMMARIES_DATA_URL = '/explorationsummarieshandler/data'

EXPLORATION_URL_PREFIX = '/explore'

EXPLORATION_URL_EMBED_PREFIX = '/embed/exploration'

FEEDBACK_STATS_URL_PREFIX = '/feedbackstatshandler'

FEEDBACK_THREAD_URL_PREFIX = '/threadhandler'

FEEDBACK_THREADLIST_URL_PREFIX = '/threadlisthandler'

FEEDBACK_THREAD_VIEW_EVENT_URL = '/feedbackhandler/thread_view_event'

FLAG_EXPLORATION_URL_PREFIX = '/flagexplorationhandler'

FRACTIONS_LANDING_PAGE_URL = '/fractions'

LEARNER_DASHBOARD_URL = '/learner_dashboard'

LEARNER_DASHBOARD_DATA_URL = '/learnerdashboardhandler/data'

LIBRARY_GROUP_DATA_URL = '/librarygrouphandler'

LIBRARY_INDEX_URL = '/library'

LIBRARY_INDEX_DATA_URL = '/libraryindexhandler'

LIBRARY_RECENTLY_PUBLISHED_URL = '/library/recently_published'

LIBRARY_SEARCH_URL = '/search/find'

LIBRARY_SEARCH_DATA_URL = '/searchhandler/data'

LIBRARY_TOP_RATED_URL = '/library/top_rated'

NEW_COLLECTION_URL = '/collection_editor_handler/create_new'

NEW_EXPLORATION_URL = '/contributehandler/create_new'

PREFERENCES_DATA_URL = '/preferenceshandler/data'

RECENT_COMMITS_DATA_URL = '/recentcommitshandler/recent_commits'

RECENT_FEEDBACK_MESSAGES_DATA_URL = '/recent_feedback_messages'

ROBOTS_TXT_URL = '/robots.txt'

SITE_FEEDBACK_FORM_URL = ''

SITE_LANGUAGE_DATA_URL = '/save_site_language'

SIGNUP_DATA_URL = '/signuphandler/data'

SIGNUP_URL = '/signup'

SPLASH_URL = '/splash'

SUGGESTION_ACTION_URL_PREFIX = '/suggestionactionhandler'

SUGGESTION_LIST_URL_PREFIX = '/suggestionlisthandler'

SUGGESTION_URL_PREFIX = '/suggestionhandler'

SUBSCRIBE_URL_PREFIX = '/subscribehandler'

UNSUBSCRIBE_URL_PREFIX = '/unsubscribehandler'

UPLOAD_EXPLORATION_URL = '/contributehandler/upload'

USER_EXPLORATION_EMAILS_PREFIX = '/createhandler/notificationpreferences'

USERNAME_CHECK_DATA_URL = '/usernamehandler/data'

NAV_MODE_ABOUT = 'about'

NAV_MODE_GET_STARTED = 'get_started'

NAV_MODE_BLOG = 'blog'

NAV_MODE_COLLECTION = 'collection'

NAV_MODE_CONTACT = 'contact'

NAV_MODE_CREATE = 'create'

NAV_MODE_CREATOR_DASHBOARD = 'creator_dashboard'

NAV_MODE_DONATE = 'donate'

NAV_MODE_EXPLORE = 'explore'

NAV_MODE_LEARNER_DASHBOARD = 'learner_dashboard'

NAV_MODE_LIBRARY = 'library'

NAV_MODE_PROFILE = 'profile'

NAV_MODE_SIGNUP = 'signup'

NAV_MODE_SPLASH = 'splash'

NAV_MODE_TEACH = 'teach'

NAV_MODE_THANKS = 'thanks'

# Event types.

EVENT_TYPE_STATE_HIT = 'state_hit'

EVENT_TYPE_ANSWER_SUBMITTED = 'answer_submitted'

EVENT_TYPE_DEFAULT_ANSWER_RESOLVED = 'default_answer_resolved'

EVENT_TYPE_NEW_THREAD_CREATED = 'feedback_thread_created'

EVENT_TYPE_THREAD_STATUS_CHANGED = 'feedback_thread_status_changed'

EVENT_TYPE_RATE_EXPLORATION = 'rate_exploration'

# The values for these event types should be left as-is for backwards

# compatibility.

EVENT_TYPE_START_EXPLORATION = 'start'

EVENT_TYPE_MAYBE_LEAVE_EXPLORATION = 'leave'

EVENT_TYPE_COMPLETE_EXPLORATION = 'complete'

ACTIVITY_STATUS_PRIVATE = 'private'

ACTIVITY_STATUS_PUBLIC = 'public'

ACTIVITY_STATUS_PUBLICIZED = 'publicized'

# Play type constants

PLAY_TYPE_PLAYTEST = 'playtest'

PLAY_TYPE_NORMAL = 'normal'

# Predefined commit messages.

COMMIT_MESSAGE_EXPLORATION_DELETED = 'Exploration deleted.'

COMMIT_MESSAGE_COLLECTION_DELETED = 'Collection deleted.'

# Unfinished features.

SHOW_TRAINABLE_UNRESOLVED_ANSWERS = False

# Number of unresolved answers to be displayed in the dashboard for each

# exploration.

TOP_UNRESOLVED_ANSWERS_COUNT_DASHBOARD = 3

# Number of open feedback to be displayed in the dashboard for each exploration.

OPEN_FEEDBACK_COUNT_DASHBOARD = 3

# NOTE TO DEVELOPERS: This should be synchronized with base.js

ENABLE_STRING_CLASSIFIER = False

SHOW_COLLECTION_NAVIGATION_TAB_HISTORY = False

SHOW_COLLECTION_NAVIGATION_TAB_STATS = False

# Output formats of downloaded explorations.

OUTPUT_FORMAT_JSON = 'json'

OUTPUT_FORMAT_ZIP = 'zip'

# Types of updates shown in the 'recent updates' table in the dashboard page.

UPDATE_TYPE_EXPLORATION_COMMIT = 'exploration_commit'

UPDATE_TYPE_COLLECTION_COMMIT = 'collection_commit'

UPDATE_TYPE_FEEDBACK_MESSAGE = 'feedback_thread'

# Possible values for user query status.

# Valid status transitions are: processing --> completed --> archived

# Or processing --> failed.

USER_QUERY_STATUS_PROCESSING = 'processing'

USER_QUERY_STATUS_COMPLETED = 'completed'

USER_QUERY_STATUS_ARCHIVED = 'archived'

USER_QUERY_STATUS_FAILED = 'failed'

# The time difference between which to consider two login events "close". This

# is taken to be 12 hours.

PROXIMAL_TIMEDELTA_SECS = 12 * 60 * 60

DEFAULT_COLOR = '#a33f40'

DEFAULT_THUMBNAIL_ICON = 'Lightbulb'

# List of supported default categories. For now, each category has a specific

# color associated with it. Each category also has a thumbnail icon whose

# filename is "{{CategoryName}}.svg".

CATEGORIES_TO_COLORS = {

'Mathematics': '#cd672b',

'Algebra': '#cd672b',

'Arithmetic': '#d68453',

'Calculus': '#b86330',

'Logic': '#d68453',

'Combinatorics': '#cf5935',

'Graph Theory': '#cf5935',

'Probability': '#cf5935',

'Statistics': '#cd672b',

'Geometry': '#d46949',

'Trigonometry': '#d46949',

'Algorithms': '#d0982a',

'Computing': '#bb8b2f',

'Programming': '#d9aa53',

'Astronomy': '#879d6c',

'Biology': '#97a766',

'Chemistry': '#aab883',

'Engineering': '#8b9862',

'Environment': '#aba86d',

'Medicine': '#97a766',

'Physics': '#879d6c',

'Architecture': '#6e3466',

'Art': '#895a83',

'Music': '#6a3862',

'Philosophy': '#613968',

'Poetry': '#7f507f',

'English': '#193a69',

'Languages': '#1b4174',

'Latin': '#3d5a89',

'Reading': '#193a69',

'Spanish': '#405185',

'Gaulish': '#1b4174',

'Business': '#387163',

'Economics': '#5d8b7f',

'Geography': '#3c6d62',

'Government': '#538270',

'History': '#3d6b52',

'Law': '#538270',

'Education': '#942e20',

'Puzzles': '#a8554a',

'Sport': '#893327',

'Welcome': '#992a2b',

}

# Types of activities that can be created with Oppia.

ACTIVITY_TYPE_EXPLORATION = 'exploration'

ACTIVITY_TYPE_COLLECTION = 'collection'

ALL_ACTIVITY_TYPES = [ACTIVITY_TYPE_EXPLORATION, ACTIVITY_TYPE_COLLECTION]

# A sorted list of default categories for which icons and background colours

# exist.

ALL_CATEGORIES = sorted(CATEGORIES_TO_COLORS.keys())

# These categories are shown in the library navbar.

SEARCH_DROPDOWN_CATEGORIES = sorted([

'Mathematics',

'Statistics',

'Algorithms',

'Programming',

'Biology',

'Chemistry',

'Physics',

'Medicine',

'English',

'Architecture',

'Art',

'Music',

'Reading',

'Business',

'Economics',

'Geography',

'History',

])

# The i18n id for the header of the "Featured Activities" category in the

# library index page.

LIBRARY_CATEGORY_FEATURED_ACTIVITIES = 'I18N_LIBRARY_GROUPS_FEATURED_ACTIVITIES'

# The i18n id for the header of the "Top Rated Explorations" category in the

# library index page.

LIBRARY_CATEGORY_TOP_RATED_EXPLORATIONS = (

'I18N_LIBRARY_GROUPS_TOP_RATED_EXPLORATIONS')

# The i18n id for the header of the "Recently Published" category in the

# library index page.

LIBRARY_CATEGORY_RECENTLY_PUBLISHED = 'I18N_LIBRARY_GROUPS_RECENTLY_PUBLISHED'

# group_name param for GET request in Splash.js

LIBRARY_CATEGORY_SPLASH_PAGE_FEATURED = 'splash_page_featured'

# The group name that appears at the end of the url for the recently published

# page.

LIBRARY_GROUP_RECENTLY_PUBLISHED = 'recently_published'

# The group name that appears at the end of the url for the top rated page.

LIBRARY_GROUP_TOP_RATED = 'top_rated'

# NOTE TO DEVELOPERS: The LIBRARY_PAGE_MODE constants defined below should have

# the same value as the ones defined in LIBRARY_PAGE_MODES in Library.js. For

# example LIBRARY_PAGE_MODE_GROUP should have the same value as

# LIBRARY_PAGE_MODES.GROUP.

# Page mode for the group pages such as top rated and recently published

# explorations.

LIBRARY_PAGE_MODE_GROUP = 'group'

# Page mode for the main library page.

LIBRARY_PAGE_MODE_INDEX = 'index'

# Page mode for the search results page.

LIBRARY_PAGE_MODE_SEARCH = 'search'

# List of supported language codes. Each description has a

# parenthetical part that may be stripped out to give a shorter

# description.

ALL_LANGUAGE_CODES = [{

'code': 'en', 'description': u'English',

}, {

'code': 'ar', 'description': u'العربية (Arabic)',

}, {

'code': 'bg', 'description': u'български (Bulgarian)',

}, {

'code': 'ca', 'description': u'català (Catalan)',

}, {

'code': 'zh', 'description': u'中文 (Chinese)',

}, {

'code': 'hr', 'description': u'hrvatski (Croatian)',

}, {

'code': 'cs', 'description': u'čeština (Czech)',

}, {

'code': 'da', 'description': u'dansk (Danish)',

}, {

'code': 'nl', 'description': u'Nederlands (Dutch)',

}, {

'code': 'tl', 'description': u'Filipino (Filipino)',

}, {

'code': 'fi', 'description': u'suomi (Finnish)',

}, {

'code': 'fr', 'description': u'français (French)',

}, {

'code': 'de', 'description': u'Deutsch (German)',

}, {

'code': 'el', 'description': u'ελληνικά (Greek)',

}, {

'code': 'he', 'description': u'עברית (Hebrew)',

}, {

'code': 'hi', 'description': u'हिन्दी (Hindi)',

}, {

'code': 'hu', 'description': u'magyar (Hungarian)',

}, {

'code': 'id', 'description': u'Bahasa Indonesia (Indonesian)',

}, {

'code': 'it', 'description': u'italiano (Italian)',

}, {

'code': 'ja', 'description': u'日本語 (Japanese)',

}, {

'code': 'ko', 'description': u'한국어 (Korean)',

}, {

'code': 'lv', 'description': u'latviešu (Latvian)',

}, {

'code': 'lt', 'description': u'lietuvių (Lithuanian)',

}, {

'code': 'no', 'description': u'Norsk (Norwegian)',

}, {

'code': 'fa', 'description': u'فارسی (Persian)',

}, {

'code': 'pl', 'description': u'polski (Polish)',

}, {

'code': 'pt', 'description': u'português (Portuguese)',

}, {

'code': 'ro', 'description': u'română (Romanian)',

}, {

'code': 'ru', 'description': u'русский (Russian)',

}, {

'code': 'sr', 'description': u'српски (Serbian)',

}, {

'code': 'sk', 'description': u'slovenčina (Slovak)',

}, {

'code': 'sl', 'description': u'slovenščina (Slovenian)',

}, {

'code': 'es', 'description': u'español (Spanish)',

}, {

'code': 'sv', 'description': u'svenska (Swedish)',

}, {

'code': 'th', 'description': u'ภาษาไทย (Thai)',

}, {

'code': 'tr', 'description': u'Türkçe (Turkish)',

}, {

'code': 'uk', 'description': u'українська (Ukrainian)',

}, {

'code': 'vi', 'description': u'Tiếng Việt (Vietnamese)',

}]

# Defaults for topic similarities

DEFAULT_TOPIC_SIMILARITY = 0.5

SAME_TOPIC_SIMILARITY = 1.0

# NOTE TO DEVELOPERS: While adding another language, please ensure that the

# languages are in alphabetical order.

SUPPORTED_SITE_LANGUAGES = [{

'id': 'id',

'text': 'Bahasa Indonesia'

}, {

'id': 'en',

'text': 'English'

}, {

'id': 'de',

'text': 'Deutsch'

}, {

'id': 'fr',

'text': 'français'

}, {

'id': 'nl',

'text': 'Nederlands'

}, {

'id': 'es',

'text': 'Español'

}, {

'id': 'hu',

'text': 'magyar'

}, {

'id': 'pt',

'text': 'Português'

}, {

'id': 'pt-br',

'text': 'Português (Brasil)'

}, {

'id': 'mk',

'text': 'македонски јазик'

}, {

'id': 'vi',

'text': 'Tiếng Việt'

}, {

'id': 'hi',

'text': 'हिन्दी'

}, {

'id': 'bn',

'text': 'বাংলা'

}, {

'id': 'tr',

'text': 'Türkçe'

}, {

'id': 'zh-hans',

'text': '中文(简体)'

}, {

'id': 'zh-hant',

'text': '中文(繁體)'

}]

SYSTEM_USERNAMES = [SYSTEM_COMMITTER_ID, MIGRATION_BOT_USERNAME]

SYSTEM_USER_IDS = [SYSTEM_COMMITTER_ID, MIGRATION_BOT_USERNAME]

# The following are all page descriptions for the meta tag.

ABOUT_PAGE_DESCRIPTION = (

'Oppia is an open source learning platform that connects a community of '

'teachers and learners. You can use this site to create 1-1 learning '

'scenarios for others.')

GET_STARTED_PAGE_DESCRIPTION = (

'Learn how to get started using Oppia.')

BLOG_PAGE_DESCRIPTION = (

'Keep up to date with Oppia news and updates via our blog.')

CONTACT_PAGE_DESCRIPTION = (

'Contact the Oppia team, submit feedback, and learn how to get involved '

'with the Oppia project.')

CREATE_PAGE_DESCRIPTION = (

'Help others learn new things. Create lessons through explorations and '

'share your knowledge with the community.')

CREATOR_DASHBOARD_PAGE_DESCRIPTION = (

'Keep track of the lessons you have created, as well as feedback from '

'learners.')

DONATE_PAGE_DESCRIPTION = (

'Donate to The Oppia Foundation.')

FORUM_PAGE_DESCRIPTION = (

'Engage with the Oppia community by discussing questions, bugs and '

'explorations in the forum.')

LIBRARY_GROUP_PAGE_DESCRIPTION = (

'Discover top-rated or recently-published explorations on Oppia. Learn '

'from these explorations or help improve an existing one for the '

'community.')

LIBRARY_PAGE_DESCRIPTION = (

'Looking to learn something new? Find explorations created by professors, '

'teachers and Oppia users in a subject you\'re interested in, and start '

'exploring!')

PREFERENCES_PAGE_DESCRIPTION = (

'Change your Oppia profile settings and preferences')

SEARCH_PAGE_DESCRIPTION = (

'Discover a new exploration to learn from, or help improve an existing '

'one for the community.')

SIGNUP_PAGE_DESCRIPTION = (

'Sign up for Oppia and begin exploring a new subject.')

SPLASH_PAGE_DESCRIPTION = (

'Oppia is a free site for sharing knowledge via interactive lessons '

'called \'explorations\'. Learn from user-created explorations, or teach '

'and create your own.')

TEACH_PAGE_DESCRIPTION = (

'The Oppia library is full of user-created lessons called \'explorations\'.'

' Read about how to participate in the community and begin creating '

'explorations.')

TERMS_PAGE_DESCRIPTION = (

'Oppia is a 501(c)(3) registered non-profit open-source e-learning '

'platform. Learn about our terms and conditions for creating and '

'distributing learning material.')

THANKS_PAGE_DESCRIPTION = (

'Thank you for donating to The Oppia Foundation.')

SITE_NAME = 'Oppia.org'

# The type of the response returned by a handler when an exception is raised.

HANDLER_TYPE_HTML = 'html'

HANDLER_TYPE_JSON = 'json'

# Following are the constants for the roles.

ROLE_GUEST = 'GUEST'

ROLE_BANNED_USER = 'BANNED_USER'

ROLE_EXPLORATION_EDITOR = 'EXPLORATION_EDITOR'

ROLE_COLLECTION_EDITOR = 'COLLECTION_EDITOR'

ROLE_MODERATOR = 'MODERATOR'

ROLE_ADMIN = 'ADMIN'

ROLE_SUPER_ADMIN = 'SUPER_ADMIN'