############################################################################### # # SageMathCloud: A collaborative web-based interface to Sage, IPython, LaTeX and the Terminal. # # Copyright (C) 2014, William Stein # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # ############################################################################### ### # # Library for working with JSON messages for Salvus. # # (c) 2012, William Stein # # We use functions to work with messages to ensure some level of # consistency, defaults, and avoid errors from typos, etc. # ### misc = require('misc') defaults = misc.defaults required = defaults.required message = (obj) -> exports[obj.event] = (opts={}) -> if opts.event? throw "ValueError: must not define 'event' when calling message creation function (opts=#{JSON.stringify(opts)}, obj=#{JSON.stringify(obj)})" defaults(opts, obj) ############################################ # Compute server messages ############################################# message event : 'compute_server_status' status : undefined # Message for actions using a compute server message event : 'compute' project_id : undefined action : required # open, save, ... args : undefined param : undefined # deprecate id : undefined message event : 'project_state_update' project_id : required state : required time : required state_error : undefined # error if there was one transitioning to this state ############################################ # Sage session management; executing code ############################################# # hub --> sage_server&console_server, etc. and browser --> hub message event : 'start_session' type : required # "sage", "console"; later this could be "R", "octave", etc. # TODO: project_id should be required project_id : undefined # the project that this session will start in session_uuid : undefined # set by the hub -- client setting this will be ignored. params : undefined # extra parameters that control the type of session id : undefined limits : undefined # hub --> browser message event : 'session_started' id : undefined session_uuid : undefined limits : undefined data_channel : undefined # The data_channel is a single UTF-16 # character; this is used for # efficiently sending and receiving # non-JSON data (except channel # '\u0000', which is JSON). # hub --> client message event : 'session_reconnect' session_uuid : undefined # at least one of session_uuid or data_channel must be defined data_channel : undefined # client <--> hub <--> local_hub # info = { # sage_sessions : {uuid:{desc:info.desc, status:info.status}, ...}, # console_sessions : {uuid:{}, ...} # } message event : 'project_session_info' id : undefined project_id : undefined info : undefined message event : 'project_status' id : undefined project_id : undefined status : undefined message event : 'project_get_state' id : undefined project_id : undefined state : undefined # # client --> hub message event : 'connect_to_session' id : undefined type : required project_id : required session_uuid : required params : undefined # extra parameters that control the type of session -- if we have to create a new one message event : 'session_connected' id : undefined session_uuid : required data_channel : undefined # used for certain types of sessions history : undefined # used for console/terminal sessions # sage_server&console_server --> hub message event : 'session_description' pid : required limits : undefined # client --> hub --> session servers message event : 'send_signal' id : undefined session_uuid : undefined # from browser-->hub this must be set pid : undefined # from hub-->sage_server this must be set signal : 2 # 2 = SIGINT, 3 = SIGQUIT, 9 = SIGKILL message event : 'signal_sent' id : required # Restart the underlying Sage process for this session; the session # with the given id still exists, it's just that the underlying sage # process got restarted. # client --> hub message event : 'restart_session' session_uuid : required id : undefined # client <----> hub <--> sage_server message event : 'terminate_session' project_id : undefined session_uuid : undefined reason : undefined done : undefined # client --> hub --> sage_server message event : 'execute_code' id : undefined code : required data : undefined session_uuid : undefined cell_id : undefined # optional extra useful information about which cells is being executed preparse : true allow_cache : true # Output resulting from evaluating code that is displayed by the browser. # sage_server --> local hub --> hubs --> clients message event : 'output' id : undefined # the id for this particular computation stdout : undefined # plain text stream stderr : undefined # error text stream -- colored to indicate an error html : undefined # arbitrary html stream md : undefined # github flavored markdown tex : undefined # tex/latex stream -- is an object {tex:..., display:...} d3 : undefined # d3 data document, e.g,. {d3:{viewer:'graph', data:{...}}} hide : undefined # 'input' or 'output'; hide display of given component of cell show : undefined # 'input' or 'output'; show display of given component of cell auto : undefined # true or false; sets whether or not cell auto-executess on process restart javascript : undefined # javascript code evaluation stream (see also 'execute_javascript' to run code directly in browser that is not part of the output stream). interact : undefined # create an interact layout defined by a JSON object obj : undefined # used for passing any JSON-able object along as output; this is used, e.g., by interact. file : undefined # used for passing a file -- is an object {filename:..., uuid:..., show:true}; the file is at https://cloud.sagemath.com/blobs/filename?uuid=[the uuid] raw_input : undefined # used for getting blocking input from client -- {raw_input:{prompt:'input stuff?', value:'', submitted:false}} done : false # the sequences of messages for a given code evaluation is done. session_uuid : undefined # the uuid of the session that produced this output once : undefined # if given, message is transient; it is not saved by the worksheet, etc. clear : undefined # if true, clears all output of the current cell before rendering message. events : undefined # {'event_name':'name of Python callable to call', ...} -- only for images right now # This message tells the client to execute the given Javascript code # in the browser. (For safety, the client may choose to ignore this # message.) If coffeescript==true, then the code is assumed to be # coffeescript and is first compiled to Javascript. This message is # "out of band", i.e., not meant to be part of any particular output # cell. That is why there is no id key. # sage_server --> hub --> client message event : 'execute_javascript' session_uuid : undefined # set by the hub, since sage_server doesn't (need to) know the session_uuid. code : required obj : undefined coffeescript : false cell_id : undefined # if set, eval scope contains an object cell that refers to the cell in the worksheet with this id. ############################################ # Session Introspection ############################################# # An introspect message from the client can result in numerous types # of responses (but there will only be one response). The id of the # message from hub back to client will match the id of the message # from client to hub; the client is responsible for deciding # what/where/how to deal with the message. # client --> hub --> sage_server message event : 'introspect' id : undefined session_uuid : required line : required preparse : true # hub --> client (can be sent in response to introspect message) message event : 'introspect_completions' id : undefined # match id of 'introspect' message target : required # 'Ellip' completions : required # ['sis', 'ticCurve', 'ticCurve_from_c4c6', ...] # hub --> client (can be sent in response to introspect message) message event : 'introspect_docstring' id : undefined target : required docstring : required # hub --> client message event : 'introspect_source_code' id : undefined target : required source_code : required ############################################ # Information about several projects or accounts ############################################# message event : 'get_project_titles' id : undefined project_ids : required message event : 'project_titles' id : undefined titles : required message event : 'get_user_names' id : undefined account_ids : required message event : 'user_names' id : undefined user_names : required ############################################ # CodeMirror editor sessions ############################################# # client --> hub --> local_hub message event : 'codemirror_get_session' path : undefined # at least one of path or session_uuid must be defined session_uuid : undefined project_id : required id : undefined # local_hub --> hub --> client message event : 'codemirror_session' id : undefined session_uuid : required path : required # absolute path content : required readonly : false # if true, the file must be treated as "read-only" by the client. # turn on or off recording of revisions of a given synchronized editing file. # The file will be called message event : 'codemirror_revision_tracking' id : undefined session_uuid : required enable : required # true or false -- if true, start recording revisions for this file; if false, stop. # A list of edits that should be applied, along with the # last version of edits received before. # client <--> hub <--> local_hub message event : 'codemirror_diffsync' id : undefined session_uuid : undefined edit_stack : required last_version_ack : required # Suggest to the connected big hub that there is data ready to be synced: # local_hub --> hub --> client message event : 'codemirror_diffsync_ready' session_uuid : undefined # Hub uses this message to tell client that client should try to sync later, since hub is # busy now with some other locking sync operation. # local_hub <-- hub message event : 'codemirror_diffsync_retry_later' id : undefined # Write out whatever is on local_hub to the physical disk # client --> hub --> local_hub message event : 'codemirror_write_to_disk' id : undefined session_uuid : undefined # local_hub --> hub --> client message event : 'codemirror_wrote_to_disk' id : undefined hash : undefined # on success, return message contains sha1 hash of what was actually written to disk. # Replace what is on local_hub by what is on physical disk (will push out a # codemirror_change message, so any browser client has a chance to undo this). # client --> hub --> local_hub message event : 'codemirror_read_from_disk' id : undefined session_uuid : undefined # Request the current content of the file. This may be # used to refresh the content in a client, even after a session started. # client --> hub --> local_hub message event : 'codemirror_get_content' id : undefined session_uuid : undefined # Sent in response to a codemirror_get_content message. # local_hub --> hub --> client message event : 'codemirror_content' id : undefined content : required # Disconnect a client from a codemirror editing session. # local_hub --> hub # client --> hub message event : 'codemirror_disconnect' id : undefined session_uuid : undefined # gets filled in # Broadcast mesg to all clients connected to this session. # This is used for cursors, updating session id's, etc. # client <--> hub <--> local_hub message event : 'codemirror_bcast' session_uuid : required self : undefined # if true, message will also be sent to self from global hub. name : undefined color : undefined date : undefined mesg : required # arbitrary message, can have event, etc., attributes. # This is used so that a client can execute code in the Sage process that is running # controlled by a codemirror sync session. This is mainly used to implement interact # in synchronized worksheets that are embedded in a single codemirror editor. # client --> hub --> local_hub --> sage_server message event : 'codemirror_execute_code' id : undefined code : required data : undefined session_uuid : required preparse : true # client --> hub --> local_hub --> sage_server message event : 'codemirror_sage_raw_input' value : required session_uuid : required # Introspection in the context of a codemirror editing session. # client --> hub --> sage_server message event : 'codemirror_introspect' id : undefined session_uuid : required line : required preparse : true # client --> hub --> local_hub message event : 'codemirror_send_signal' id : undefined session_uuid : required signal : 2 # 2 = SIGINT, 3 = SIGQUIT, 9 = SIGKILL ############################################ # Account Management ############################################# # client --> hub message event : 'create_account' id : undefined first_name : required last_name : required email_address : required password : required agreed_to_terms: required token : undefined # only required when token is set. # hub --> client message event : 'account_creation_failed' id : undefined reason : required # client <--> hub message event : 'email_address_availability' id : undefined email_address : required is_available : undefined # client --> hub message id : undefined event : 'sign_in' email_address : required password : required remember_me : false # hub --> client message id : undefined event : 'remember_me_failed' reason : required # client --> hub message id : undefined event : 'sign_in_failed' email_address : required reason : required # hub --> client; sent in response to either create_account or log_in message event : 'signed_in' id : undefined # message uuid remember_me : required # true if sign in accomplished via remember_me cookie; otherwise, false. hub : required # ip address (on vpn) of hub user connected to. account_id : required # uuid of user's account email_address : undefined # email address they signed in under first_name : undefined last_name : undefined # client --> hub message event : 'sign_out' everywhere : false id : undefined # hub --> client message event : 'signed_out' id : undefined # client --> hub message event : 'change_password' id : undefined email_address : required old_password : "" new_password : required # hub --> client # if error is true, that means the password was not changed; would # happen if password is wrong (message:'invalid password'). message event : 'changed_password' id : undefined error : undefined # client --> hub: "please send a password reset email" message event : "forgot_password" id : undefined email_address : required # hub --> client "a password reset email was sent, or there was an error" message event : "forgot_password_response" id : undefined error : false # client --> hub: "reset a password using this id code that was sent in a password reset email" message event : "reset_forgot_password" id : undefined reset_code : required new_password : required message event : "reset_forgot_password_response" id : undefined error : false # client --> hub message event : 'change_email_address' id : undefined account_id : required old_email_address : "" new_email_address : required password : "" # hub --> client message event : 'changed_email_address' id : undefined error : false # some other error ttl : undefined # if user is trying to change password too often, this is time to wait # Unlink a passport auth for this account. # client --> hub message event : 'unlink_passport' strategy : required id : required ############################################ # Account Settings ############################################# # client --> hub message event : "get_account_settings" id : undefined account_id : required # settings that require the password in the message (so user must # explicitly retype password to change these): exports.restricted_account_settings = plan_id : undefined plan_name : undefined plan_starttime : undefined storage_limit : undefined session_limit : undefined max_session_time : undefined ram_limit : undefined support_level : undefined email_address : undefined passports : undefined password_is_set : undefined groups : undefined # only admins can actually change this... # these can be changed without additional re-typing of the password # (of course, user must have somehow logged in): exports.unrestricted_account_settings = first_name : required last_name : required default_system : required evaluate_key : required email_new_features : required email_maintenance : required enable_tooltips : required autosave : required # time in seconds or 0 to disable terminal : required # JSON object -- client interprets editor_settings : required # JSON object -- client interprets other_settings : required # JSON object exports.account_settings_defaults = plan_id : 0 # the free trial plan default_system : 'sage' evaluate_key : 'Shift-Enter' email_new_features : true email_maintenance : true enable_tooltips : true autosave : 45 groups : undefined other_settings : confirm_close : false mask_files : true default_file_sort : 'time' editor_settings : strip_trailing_whitespace : false show_trailing_whitespace : true line_wrapping : true line_numbers : true smart_indent : true electric_chars : true match_brackets : true auto_close_brackets : true code_folding : true match_xml_tags : true auto_close_xml_tags : true spaces_instead_of_tabs : true multiple_cursors : true track_revisions : true extra_button_bar : true first_line_number : 1 indent_unit : 4 tab_size : 4 bindings : "standard" theme : "standard" undo_depth : 300 terminal : font_size : 14 color_scheme : 'default' font : 'monospace' # client <--> hub message( misc.merge({}, event : "account_settings" account_id : required id : undefined password : undefined # only set when sending message from client to hub; must be set to change restricted settings exports.unrestricted_account_settings, exports.restricted_account_settings ) ) message event : 'account_settings_saved' id : undefined message event : 'error' id : undefined error : undefined message event : 'success' id : undefined # You need to reconnect. message event : 'reconnect' id : undefined reason : undefined # optional to make logs more informative ############################################# # Scratch worksheet ############################################# message event : 'save_scratch_worksheet' data : required id : undefined message event : 'load_scratch_worksheet' id : undefined message event : 'delete_scratch_worksheet' id : undefined message event : 'scratch_worksheet_loaded' id : undefined data : undefined # undefined means there is no scratch worksheet yet ############################################ # User Feedback ############################################# message event : 'report_feedback' id : undefined category : required # 'bug', 'idea', 'comment' description : required # text nps : undefined # net promotor score; integer 1,2,...,9 message event : 'feedback_reported' error : undefined id : required message event : 'get_all_feedback_from_user' error : undefined id : undefined message event : 'all_feedback_from_user' id : required error : undefined data : required # JSON list of objects ###################################################################################### # This is a message that goes # hub --> client # In response, the client grabs "/cookies?id=...,set=...,get=..." via an AJAX call. # During that call the server can get/set HTTP-only cookies. # (Note that the /cookies url gets customized by base_url.) ###################################################################################### message event : 'cookies' id : required url : "/cookies" get : undefined # name of a cookie to get set : undefined # name of a cookie to set value : undefined # value to set cookie to ###################################################################################### # Activity loging and notification ###################################################################################### # # client --> hub to indicate that there was some activity by this user on the given path # message event : 'get_all_activity' # get activity, by default for all projects that this user collaborates on; will be limited in time/number id : undefined message event : 'all_activity' id : undefined activity_log : required # input to misc.activity_log function. message event : 'recent_activity' updates : required # list of specific records that just got added to recent_activity_by_project2 message event : 'mark_activity' mark : required # 'read', 'seen' events : required # list of {path:'project_id/filesystem_path', timestamp:number} # older stuff below message event : 'path_activity' id : undefined project_id : required path : required # Add a comment, e.g., "read" or "seen", to this users activity notification # stream for the given path. message event : 'add_comment_to_activity_notification_stream' id : undefined project_id : required path : required comment : required message event : 'activity_notifications' notifications : required update : false # if specified then only giving update since the given time message event : 'mark_notifications' mark : required # 'read', 'seen' id : undefined id_list : required # client --> hub message event : "get_notifications_syncdb" id : undefined # hub --> client message event : "notifications_syncdb" id : undefined string_id : required ################################################################################### # # Project Server <---> Hub interaction # # These messages are mainly focused on working with individual projects. # # Architecture: # # * The database stores a files object (with the file tree), logs # (of each branch) and a sequence of git bundles that when # combined together give the complete history of the repository. # Total disk usage per project is limited by hard/soft disk quota, # and includes the space taken by the revision history (the .git # directory). # # * A project should only be opened by at most one project_server at # any given time (not implemented: if this is violated then we'll # merge the resulting conflicting repo's.) # # * Which project_server that has a project opened is stored in the # database. If a hub cannot connect to a given project server, # the hub assigns a new project_server for the project and opens # the project on the new project_server. (The error also gets # logged to the database.) All hubs will use this new project # server henceforth. # ################################################################################### # The open_project message causes the project_server to create a new # project or prepare to receive one (as a sequence of blob messages) # from a hub. # # hub --> project_server message event : 'open_project' id : required project_id : required # uuid of the project, which impacts # where project is extracted, etc. quota : required # Maximum amount of disk space/inodes this # project can use. This is an object # {disk:{soft:megabytes, hard:megabytes}, inode:{soft:num, hard:num}} idle_timeout : required # A time in seconds; if the project_server # does not receive any messages related # to this project for this many seconds, # then it does the same thing as when # receiving a 'close_project' message. ssh_public_key: required # ssh key of the one UNIX user that is allowed to access this account (this is running the hub). # A project_server sends the project_opened message to the hub once # the project_server has received and unbundled all bundles that # define a project. # project_server --> hub message event : 'project_opened' id : required # A hub sends the save_project message to a project_server to request # that the project_server save a snapshot of this project. On # success, the project_server will respond by sending a project_saved # message then sending individual the bundles n.bundle for n >= # starting_bundle_number. # # client --> hub --> project_server message event : 'save_project' id : undefined project_id : required # uuid of a project # The project_saved message is sent to a hub by a project_server when # the project_servers creates a new snapshot of the project in # response to a save_project message. # project_server --> hub message event : 'project_saved' id : required # message id, which matches the save_project message bundle_uuids : required # {uuid:bundle_number, uuid:bundle_number, ...} -- bundles are sent as blobs in separate messages. ############################################# # # Client/user browsing snapshots of a project, restoring, etc. # ############################################# message event : 'snap' id : undefined command : required # 'ls', 'restore', 'log', 'last', 'status' project_id : required # if snapshot not given, then command must be "ls", and server returns a list of available snapshots in reverse order snapshot : undefined path : '.' # when 'ls', returns listing of files in this path (if snapshot given), with slash # at end of filename to denote a directory. timeout : 600 # how long to wait for response from the storage server before sending an error list : undefined # response message is of same type, but has this filled in for 'ls' and 'log' commands. timezone_offset: 0 # the difference (UTC time) - (local time), in minutes, where local time is of the client ###################################################################### # Execute a program in a given project ###################################################################### # client --> project message event : 'project_exec' id : undefined project_id : undefined path : '' # if relative, is a path under home; if absolute is what it is. command : required args : [] timeout : 10 # maximum allowed time, in seconds. max_output : undefined # maximum number of characters in the output bash : false # if true, args are ignored and command is run as a bash command err_on_exit : true # if exit code is nonzero send error return message instead of the usual output. # project --> client message event : 'project_exec_output' id : required stdout : required stderr : required exit_code : required # client --> project message event : 'project_restart' id : undefined project_id : required ###################################################################### # Jupyter server ###################################################################### # starts jupyter hub server and reports the port it is running on # hub <--> project message event : 'jupyter_port' port : undefined # gets set in response id : undefined ############################################################################# # A hub sends this message to the project_server to request that the # project_server close the project. This immediately deletes all files # and clears up all resources allocated for this project. So make # sure to send a save_project message first! # # client --> hub --> project_server message event : 'close_project' id : undefined project_id : required # A project_server sends this message in response to a close_project # message, to indicate that files have been cleaned up and relevant # processes killed. # project_server --> hub message event : 'project_closed' id : required # id of message (matches close_project message above) # The read_file_from_project message is sent by the hub to request # that the project_server read a file from a project and send it back # to the hub as a blob. Also sent by client to hub to request a file # or directory. If path is a directory, the optional archive field # specifies how to create a single file archive, with supported # options including: 'tar', 'tar.bz2', 'tar.gz', 'zip', '7z'. # # client --> hub --> project_server message event : 'read_file_from_project' id : undefined project_id : required path : required archive : 'tar.bz2' # The file_read_from_project message is sent by the project_server # when it finishes reading the file from disk. # project_server --> hub message event : 'file_read_from_project' id : required data_uuid : required # The project_server will send the raw data of the file as a blob with this uuid. archive : undefined # if defined, means that file (or directory) was archived (tarred up) and this string was added to end of filename. # hub --> client message event : 'temporary_link_to_file_read_from_project' id : required url : required # The client sends this message to the hub in order to write (or # create) a plain text file (binary files not allowed, since sending # them via JSON makes no sense). # client --> hub message event : 'read_text_file_from_project' id : undefined project_id : required path : required # hub --> client message event : 'text_file_read_from_project' id : required content : required # client --> hub --> project_server message event : 'make_directory_in_project' id : required project_id : required path : required # project_server --> hub --> client message event : 'directory_made_in_project' id : required # client --> hub --> project_server message event : 'move_file_in_project' id : undefined project_id : required src : required dest : required # project_server --> hub --> client message event : 'file_moved_in_project' id : required # client --> hub --> project_server message event : 'remove_file_from_project' id : undefined project_id : required path : required # The write_file_to_project message is sent from the hub to the # project_server to tell the project_server to write a file to a # project. If the path includes directories that don't exists, # they are automatically created (this is in fact the only way # to make a new directory). # hub --> project_server message event : 'write_file_to_project' id : required project_id : required path : required data_uuid : required # hub sends raw data as a blob with this uuid immediately. # The client sends this message to the hub in order to write (or # create) a plain text file (binary files not allowed, since sending # them via JSON makes no sense). # client --> hub message event : 'write_text_file_to_project' id : undefined project_id : required path : required content : required # The file_written_to_project message is sent by a project_server to # confirm successful write of the file to the project. # project_server --> hub message event : 'file_written_to_project' id : required ############################################ # Branches ############################################ # client --> hub message event : 'create_project_branch' id : undefined project_id : required branch : required message event : 'checkout_project_branch' id : undefined project_id : required branch : required message event : 'delete_project_branch' id : undefined project_id : required branch : required message event : 'merge_project_branch' id : undefined project_id : required branch : required ############################################ # Managing multiple projects ############################################ # client --> hub message event : 'create_project' id : undefined title : required description: required public : required # client --> hub message event : 'delete_project' id : undefined project_id : required # client --> hub message event : 'move_project' id : undefined project_id : required target : undefined # prefered destination of move message event : 'project_moved' id : undefined location : required # new location # client --> hub message event : 'undelete_project' id : undefined project_id : required # hub --> client message event : 'project_created' id : required project_id : required # client --> hub message event : 'hide_project_from_user' id : undefined project_id : required account_id : undefined # owner can optionally hide project from other users # client --> hub message event : 'unhide_project_from_user' id : undefined project_id : required account_id : undefined # owner can optionally unhide project for other users # Get info about a single project (instead of all projects) # client --> hub message event : 'get_project_info' project_id : required id : undefined # Response to get_project_info message. # hub --> client message event : 'project_info' info : required id : undefined # client --> hub message event : 'get_projects' id : undefined hidden : false # hub --> client message event : 'all_projects' id : required projects : required # [{project_id:, type: , title:, last_edited:}, ...] # client --> hub message event : 'update_project_data' id : undefined project_id : required data : required # an object; sets the fields in this object, and leaves alone the rest # When project data is changed by one client, the following is sent to # all clients that have access to this project (owner or collaborator). # hub --> client message event : 'project_data_updated' id : undefined project_id : required # hub --> client(s) message event : 'project_list_updated' ## linked projects --------------------------- # client <--> hub message event : 'linked_projects' id : undefined project_id : undefined add : undefined # array of project_id's remove : undefined # array of project_id's list : undefined # if add/remove are undefined in client-->hub message, then list it list of project_id's in the hub-->client message ## search --------------------------- # client --> hub message event : 'user_search' id : undefined query : required # searches for match in first_name or last_name. limit : 20 # maximum number of results requested # hub --> client message event : 'user_search_results' id : undefined results : required # list of {first_name:, last_name:, account_id:} objects. # client --> hub message event : 'get_project_users' project_id : required id : undefined # hub --> client message event : 'project_users' id : undefined users : required # list of {account_id:?, first_name:?, last_name:?, mode:?, state:?} message event : 'invite_collaborator' id : undefined project_id : required account_id : required message event : 'remove_collaborator' id : undefined project_id : required account_id : required message event : 'invite_noncloud_collaborators' id : undefined project_id : required to : required email : required # spam vector message event : 'invite_noncloud_collaborators_resp' id : undefined mesg : required ############################################ # Get the current server version number. # # This can be used by clients or even the local_hub to # force or recommend a refresh/restart. # ############################################# # client <---> hub message event : 'get_version' id : undefined version : undefined # gets filled in by the hub ############################################ # # Get various stats about cloud.sagemath. # The output stats object is at least has this # # { accounts: number, projects: number, active_projects:number } # # and may have other stats. These are cached in RAM on the # server for some amount of time, so might not be the # absolutely latest numbers. # ############################################# # client <---> hub message event : 'get_stats' id : undefined stats : undefined # gets filled in by the hub ############################################# # # Message sent in response to attempt to save a blob # to the database. # # hub --> local_hub --> sage_server # ############################################# message event : 'save_blob' id : undefined sha1 : required # the sha-1 hash of the blob that we just processed ttl : undefined # ttl in seconds of the blob if saved; 0=infinite error : undefined # if not saving, a message explaining why. # remove the ttls from blobs in the blobstore. # client --> hub message event : 'remove_blob_ttls' id : undefined uuids : required # list of sha1 hashes of blobs stored in the blobstore # DEPRECATED -- used by bup_server message event : 'storage' action : required # open, save, snapshot, latest_snapshot, close project_id : undefined param : undefined id : undefined message event : 'projects_running_on_server' id : undefined projects : undefined # for response ########################################################### # # Direct messaging between browser client and local_hub, # forwarded on by global hub after ensuring write access. # ########################################################### message event : 'local_hub' project_id : required timeout : undefined id : undefined multi_response : false message : required # arbitrary message ########################################################### # # Copy a path from one project to another. # ########################################################### message event : 'copy_path_between_projects' id : undefined src_project_id : required # id of source project src_path : required # relative path of director or file in the source project target_project_id : required # if of target project target_path : undefined # defaults to src_path overwrite_newer : false # overwrite newer versions of file at destination (destructive) delete_missing : false # delete files in dest that are missing from source (destructive) timeout : undefined # how long to wait for the copy to complete before reporting "error" (though it could still succeed) ########################################################## # # Tasks (ALL DEPRECATED -- delete all this) # ########################################################## message event : 'create_task' task_list_id : required title : "No title" position : 0 project_id : undefined # give this if task list usage is authenticated via project_id (otherwise account_id used) id : undefined message event : 'task_created' task_id : required id : undefined message event : 'edit_task' task_list_id : required task_id : required project_id : undefined # give this if task list usage is authenticated via project_id id : undefined title : undefined position : undefined done : undefined data : undefined sub_task_list_id : undefined # a list of subtasks deleted : undefined message event : 'create_task_list' owners : required # list of project_id's or account_id's that are allowed to edit this task list. id : undefined message event : 'task_list_created' task_list_id : required id : undefined message event : 'edit_task_list' task_list_id : required data : undefined project_id : undefined # give this if task list usage is authenticated via project_id deleted : undefined id : undefined message event : 'get_task_list' task_list_id : required columns : undefined include_deleted : false project_id : undefined # give this if task list usage is authenticated via project_id id : undefined message event : 'task_list_resp' id : undefined task_list : required # list of all tasks message event : 'get_task_list_last_edited' task_list_id : required project_id : undefined # give this if task list usage is authenticated via project_id id : undefined message event : 'set_project_task_list' task_list_id : required project_id : required id : undefined # hub --> connected clients who would care -- implementing this will require a message queue (like nanomsg) message event : 'sync_task_list' task_list_id : required task_id : required task : undefined # if task is created or edited this is given with new version; if deleted this is undefined ############################################# # Admin Functionality ############################################# # client --> hub; will result in an error if the user is not in the admin group. message event : 'project_set_quotas' id : undefined project_id : required # the id of the project's id to set. memory : undefined # RAM in megabytes cpu_shares : undefined # fair sharing with everybody is 256, not 1 !!! cores : undefined # integer max number of cores user can use (>=1) disk : undefined # disk quota in megabytes mintime : undefined # time in **seconds** until idle projects are terminated network : undefined # true or false; if true, full access to outside networ # client --> hub: admins can set a token that anybody creating an account must # know to be allowed to create an account. For now there is just one global token. message event : 'set_account_creation_token' id : undefined token : required # a string # client <--> hub message event : 'get_account_creation_token' id : undefined token : undefined # comes back in here ############################################# # Printing Files ############################################# message event : "print_to_pdf" id : undefined path : required options : undefined message event : 'printed_to_pdf' id : undefined path : required message event : 'ping' id : undefined message event : 'pong' id : undefined ############################################# # Reading listings and files from projects # without invoking the project server and # write auth requirement. Instead the given # path in the project must be public. These # functions don't even assume the client has # logged in. ############################################# # return a JSON object with all data that is # meant to be publically available about this project, # who owns it, the title/description, etc. message event : 'public_get_project_info' id : undefined project_id : required message event : 'public_project_info' id : undefined info : required # public request of listing of files in a project. message event : 'public_get_directory_listing' id : undefined project_id : required path : required hidden : false # show hidden files time : false # sort by timestamp, with newest first? start : 0 limit : -1 message event : 'public_directory_listing' id : undefined result : required # public request of contents of a text file in project message event : 'public_get_text_file' id : undefined project_id : required path : required message event : 'public_text_file_contents' id : undefined data : required message event : 'publish_path' id : undefined project_id : required path : required description : required message event : 'unpublish_path' id : undefined project_id : required path : required message event : 'get_public_paths' id : undefined project_id : required message event : 'public_paths' id : undefined paths : required # list of {path:?, description:?} message event : 'copy_public_path_between_projects' id : undefined src_project_id : required # id of source project src_path : required # relative path of director or file in the source project target_project_id : required # if of target project target_path : undefined # defaults to src_path overwrite_newer : false # overwrite newer versions of file at destination (destructive) delete_missing : false # delete files in dest that are missing from source (destructive) timeout : undefined # how long to wait for the copy to complete before reporting "error" (though it could still succeed) message event : 'log_client_error' error : required ############################################# # stripe integration ############################################# # Set the stripe payment method for this user. # customer info message event : 'stripe_get_customer' id : undefined message event : 'stripe_customer' id : undefined customer : undefined # if user already has a stripe customer account, info about it. stripe_publishable_key : undefined # if stripe is configured for this SMC instance, this is the public API key. # card message event : 'stripe_create_source' id : undefined token : required message event : 'stripe_delete_source' card_id : required id : undefined message event : 'stripe_set_default_source' card_id : required id : undefined message event : 'stripe_update_source' card_id : required info : required # see https://stripe.com/docs/api/node#update_card, except we don't allow changing metadata id : undefined # subscriptions to plans # Get a list of all currently available plans: message event : 'stripe_get_plans' id : undefined message event : 'stripe_plans' id : undefined plans : required # [{name:'Basic', projects:1, description:'...', price:'$10/month', trial_period:'30 days', ...}, ...] # Create a subscription to a plan message event : 'stripe_create_subscription' id : undefined plan : required # name of plan quantity : 1 coupon : undefined projects : undefined # list of projects to which the plan applies # Delete a subscription to a plan message event : 'stripe_cancel_subscription' id : undefined subscription_id : required at_period_end : false # Modify a subscription to a plan, e.g., change which projects plan applies to. message event : 'stripe_update_subscription' id : undefined subscription_id : required quantity : undefined # only give if changing projects : undefined # change associated projects from what they were to new list plan : undefined # change plan to this coupon : undefined # apply a coupon to this subscription message event : 'stripe_get_subscriptions' id : undefined limit : undefined # between 1 and 100 (default: 10) ending_before : undefined # see https://stripe.com/docs/api/node#list_charges starting_after : undefined message event : 'stripe_subscriptions' id : undefined subscriptions : undefined # charges message event : 'stripe_get_charges' id : undefined limit : undefined # between 1 and 100 (default: 10) ending_before : undefined # see https://stripe.com/docs/api/node#list_charges starting_after : undefined message event : 'stripe_charges' id : undefined charges : undefined # invoices message event : 'stripe_get_invoices' id : undefined limit : undefined # between 1 and 100 (default: 10) ending_before : undefined # see https://stripe.com/docs/api/node#list_customer_invoices starting_after : undefined message event : 'stripe_invoices' id : undefined invoices : undefined message event : 'stripe_admin_create_invoice_item' id : undefined email_address : undefined # one of email or account_id must be given. account_id : undefined # user who will be invoiced amount : required # currently in US dollars description : required