Puzzlehunt Server Documentation

Transcription

1 Puzzlehunt Server Documentation Release v3.1.1 Dillon Lareau Feb 16, 2018

2 Contents 1 Setup Environment setup Code Setup Database setup Django setup Apache setup Basics Design Dynamic Content Static Content Database Models 5 4 Views Hunt Views Info Views Staff Views Auth Views How to Create a Hunt Create Hunt Object Edit Hunt Template Create Puzzle Objects Create Auto-Response Objects Update Current Hunt Label How to Run a Hunt Download Puzzles Playtester Setup Hunt Start Staff Pages / During the Hunt Hunt End Changelog Version Older Versions Contribute 22 i

3 Chapter 1 Setup Instructions on how to setup a machine to run this project. 1.1 Environment setup Install the following packages: python 2.7 mysql-client mysql-server python-mysqldb python-dev imagemagick libmysqlclient-dev Install the required python packages using: pip install -r requirements.txt 1.2 Code Setup If you haven t already, clone the repository to a location that the user running the server will have access to. Instantiate a copy of the secret settings file by copying the secret settings template: cp puzzlehunt_server/secret_settings.py.template puzzlehunt_server/secret_settings.py Then replace the default settings such as the database login details and secret key. (If needed, look up instructions on how to generate a new secret key) 1

4 1.3 Database setup This project is configured to use a MySQL database. It can be configured to use a different type of database by modifying settings in secret_settings.py, but those modifications are out of the scope of this setup. First we have to create the user and database that the application will use. To do so, log into the mysql client as a superuser and enter the following commands. (substituting your password and username) CREATE DATABASE puzzlehunt_db; GRANT ALL PRIVILEGES ON puzzlehunt_db.* TO 'nottherealusername'@'localhost' IDENTIFIED BY 'nottherealpassword'; 1.4 Django setup Migrate the database by running python manage.py migrate. Create a superuser for the project by running python manage.py createsuperuser and following the instructions. Collect all of the static files by running python manage.py collectstatic. At this point the server should be able to start up. Developers note: There may be a few other steps before the server will function without error. For example I believe it expects at least one hunt object to exist. I hope to one day have those needs either be documented or not exist any more. 1.5 Apache setup The full setup of an apache server is beyond this documentation, but an example configuration file that should be a good starting point is available in the /config directory of the repository. That particular configuration file requires: libapache2-mod-xsendfile libapache2-mod-proxy-html libapache2-mod-wsgi libapache2-mod-shib2 Part of the server and the apache configuration is the integration with Shibboleth for secure authentication of users. Again, this documentation couldn t possibly go over all aspects of setup. If you are setting this up from scratch, I recommend the following link: CMU Shibboleth Setup Instructions However replace the CMU provided shibboleth2.xml with the shibboleth2.xml in the /config directory of the repository Database setup 2

5 Chapter 2 Basics Despite it s size, this project only has one main app named huntserver which does nearly everything. This page is meant to outline basic low level operational aspects and design choices of the server. You can find more on how to effectively create and run a hunt in other pages. 2.1 Design The design of this project is somewhat divided into two parts, the staff experience and the hunt participant experience. Staff is anyone that has the staff attribute set in the admin page. These users have access to the /staff/ area of the site; however, in order to access all functions and access the /admin/ area of the site, the user must also be a superuser as designated by Django. 2.2 Dynamic Content Dynamic content is created by using a combination of the model-view controller and the default Django templating engine. Both are extensively documented on Django s website. Both models and views used in this project are documented by later pages. 2.3 Static Content Static files are managed by Django with each app having it s own collection of static files. These files are gathered in the main static directory ({PROJECT FOLDER}/static/ ) by running python manage.py collectstatic. This main static directory is not tracked by git, and therefore you should not put any content directly into this folder. Puzzles should not be checked into the Github repository. They should exist on some accessible online file source (we have used Dropbox in the past) and will be downloaded and converted when the admin choses to do so. Once downloaded, the puzzle files live in {PROJECT FOLDER}/media/puzzles/ and are named using the puzzle id field of the puzzle which is enforced to be unique to each puzzle. To protect users from being able to just go to /media/puzzles/{puzzle_id}.pdf and get puzzles, the server comes included with a protected routing path utilizing X-Sendfile. The /protected/ URL will only allow a user to 3

6 access puzzle files if they have unlocked the puzzle. To avoid hard-coding that path, you can use the variable settings.protected_url after importing the project settings. It is a bit simplistic, but anything in the puzzles directory is permission guarded by the first 3 characters of the filename. If the requesting user has access to the puzzle object with the corresponding 3 character puzzle_id, then they will have access to that file. You can use this to protect files other than just the puzzle PDFs and PNGs. You should protect your /media/puzzles URL by only allowing access to /media/puzzles/ from internal sources. The Apache configuration for this project includes protection like this already. 2.4 Database As noted in setup, the default database for this project is a MySQL database. After setup, the database should never need to be modified by hand, additions or deletions should be done from the online admin GUI or if absolutely necessary, from the Django interactive shell. Modifications to the table structure should only be done by modifying models.py and using the automatically created migration files Database 4

7 Chapter 3 Models class huntserver.models.hunt(*args, **kwargs) Base class for a hunt. Contains basic details about a puzzlehunt. Parameters id (AutoField) Id hunt_name (CharField) The name of the hunt as the public will see it hunt_number (IntegerField) A number used internally for hunt sorting, must be unique team_size (IntegerField) Team size start_date (DateTimeField) The date/time at which a hunt will become visible to registered users end_date (DateTimeField) The date/time at which a hunt will be archived and available to the public location (CharField) Starting location of the puzzlehunt is_current_hunt (BooleanField) Is current hunt template (TextField) The template string to be rendered to HTML on the hunt page exception DoesNotExist exception MultipleObjectsReturned is_locked A boolean indicating whether or not the hunt is locked is_open A boolean indicating whether or not the hunt is open to registered participants is_public A boolean indicating whether or not the hunt is open to the public class huntserver.models.huntassetfile(*args, **kwargs) A class to represent an asset file for a puzzlehunt Parameters id (AutoField) Id 5

8 file (FileField) File exception DoesNotExist exception MultipleObjectsReturned class huntserver.models.message(*args, **kwargs) A class that represents a message sent using the chat functionality Parameters id (AutoField) Id team_id (ForeignKey to Team) The team that this message is being sent to/from is_response (BooleanField) A boolean representing whether or not the message is from the staff text (CharField) Message text time (DateTimeField) Message send time exception DoesNotExist exception MultipleObjectsReturned class huntserver.models.overwritestorage(location=none, base_url=none, file_permissions_mode=none, directory_permissions_mode=none) get_available_name(name) Returns a filename that s free on the target storage system, and available for new content to be written to. class huntserver.models.person(*args, **kwargs) A class to associate more personal information with the default django auth user class Parameters id (AutoField) Id user_id (OneToOneField to User) The corresponding user to this person phone (CharField) Person s phone number, no particular formatting allergies (CharField) Allergy information for the person comments (CharField) Comments or other notes about the person is_shib_acct (BooleanField) A boolean to indicate if the person uses shibboleth authentication for login teams (ManyToManyField) Teams that the person is on exception DoesNotExist exception MultipleObjectsReturned class huntserver.models.puzzle(*args, **kwargs) A class representing a puzzle within a hunt Parameters id (AutoField) Id puzzle_number (IntegerField) The number of the puzzle within the hunt, for sorting purposes 6

9 puzzle_name (CharField) The name of the puzzle as it will be seen by hunt participants puzzle_id (CharField) A 3 character hex string that uniquely identifies the puzzle answer (CharField) The answer to the puzzle, not case sensitive link (URLField) The full link (needs to a publicly accessible PDF of the puzzle num_required_to_unlock (IntegerField) Number of prerequisite puzzles that need to be solved to unlock this puzzle hunt_id (ForeignKey to Hunt) The hunt that this puzzle is a part of num_pages (IntegerField) Number of pages in the PDF for this puzzle. Set automatically upon download unlocks (ManyToManyField) Puzzles that this puzzle is a possible prerequisite for exception DoesNotExist exception MultipleObjectsReturned serialize_for_ajax() Serializes the ID, puzzle_number and puzzle_name fields for ajax transmission class huntserver.models.response(*args, **kwargs) A class to represent an automated response regex Parameters id (AutoField) Id puzzle_id (ForeignKey to Puzzle) The puzzle that this automated response is related to regex (CharField) The python-style regex that will be checked against the user s response text (CharField) The text to use in the submission response if the regex matched exception DoesNotExist exception MultipleObjectsReturned class huntserver.models.solve(*args, **kwargs) A class that links a team and a puzzle to indicate that the team has solved the puzzle Parameters id (AutoField) Id puzzle_id (ForeignKey to Puzzle) The puzzle that this is a solve for team_id (ForeignKey to Team) The team that this solve is from submission_id (ForeignKey to Submission) The submission object that the team submitted to solve the puzzle exception DoesNotExist exception MultipleObjectsReturned serialize_for_ajax() Serializes the puzzle, team, time, and status fields for ajax transmission class huntserver.models.submission(*args, **kwargs) A class representing a submission to a given puzzle from a given team 7

10 Parameters id (AutoField) Id team_id (ForeignKey to Team) The team that made the submission submission_time (DateTimeField) Submission time submission_text (CharField) Submission text response_text (CharField) Response to the given answer. Empty string indicates human response needed puzzle_id (ForeignKey to Puzzle) The puzzle that this submission is in response to modified_date (DateTimeField) Last date/time of response modification exception DoesNotExist exception MultipleObjectsReturned is_correct A boolean indicating if the submission given is exactly correct serialize_for_ajax() Serializes the time, puzzle, team, and status fields for ajax transmission class huntserver.models.team(*args, **kwargs) A class representing a team within a hunt Parameters id (AutoField) Id team_name (CharField) The team name as it will be shown to hunt participants hunt_id (ForeignKey to Hunt) The hunt that the team is a part of location (CharField) The physical location that the team is solving at join_code (CharField) The 5 character random alphanumeric password needed for a user to join a team playtester (BooleanField) A boolean to indicate if the team is a playtest team and will get early access solved (ManyToManyField) The puzzles the team has solved unlocked (ManyToManyField) The puzzles the team has unlocked unlockables (ManyToManyField) The unlockables the team has earned exception DoesNotExist exception MultipleObjectsReturned is_normal_team A boolean indicating whether or not the team is a normal (non-playtester) team is_playtester_team A boolean indicating whether or not the team is a playtesting team class huntserver.models.unlock(*args, **kwargs) A class that links a team and a puzzle to indicate that the team has unlocked the puzzle Parameters id (AutoField) Id 8

11 puzzle_id (ForeignKey to Puzzle) The puzzle that this is an unlock for team_id (ForeignKey to Team) The team that this unlocked puzzle is for time (DateTimeField) The time this puzzle was unlocked for this team exception DoesNotExist exception MultipleObjectsReturned class huntserver.models.unlockable(*args, **kwargs) A class that represents an object to be unlocked after solving a puzzle Parameters id (AutoField) Id puzzle_id (ForeignKey to Puzzle) The puzzle that needs to be solved to unlock this object content_type (CharField) The type of object that is to be unlocked, can be IMG, PDF, TXT, or WEB content (CharField) The link to the content, files must be externally hosted. exception DoesNotExist exception MultipleObjectsReturned 9

12 Chapter 4 Views 4.1 Hunt Views huntserver.hunt_views.protected_static(request, file_path) A view to serve protected static content. Does a permission check and if it passes, the file is served via X- Sendfile. huntserver.hunt_views.hunt(request, hunt_num) The main view to render hunt templates. Does various permission checks to determine the set of puzzles to display and then renders the string in the hunt s template field to HTML. huntserver.hunt_views.current_hunt(request) A simple view that calls huntserver.hunt_views.hunt with the current hunt s number. huntserver.hunt_views.puzzle_view(request, puzzle_id) A view to handle answer submissions via POST, handle response update requests via AJAX, and render the basic per-puzzle pages. huntserver.hunt_views.chat(request) A view to handle message submissions via POST, handle message update requests via AJAX, and render the hunt participant view of the chat. huntserver.hunt_views.unlockables(request) A view to render the unlockables page for hunt participants. 4.2 Info Views huntserver.info_views.index(request) Main landing page view, mostly static with the exception of hunt info huntserver.info_views.current_hunt_info(request) Information about the current hunt, mostly static with the exception of hunt info huntserver.info_views.previous_hunts(request) A view to render the list of previous hunts, will show any hunt that is public huntserver.info_views.registration(request) The view that handles team registration. Mostly deals with creating the team object from the post request. The rendered page is nearly entirely static. 10

13 huntserver.info_views.user_profile(request) A view to handle user information update POST data and render the user information form. 4.3 Staff Views huntserver.staff_views.queue(request, page_num) A view to handle queue response updates via POST, handle submission update requests via AJAX, and render the queue page. Submissions are pre-rendered for standard and AJAX requests. huntserver.staff_views.progress(request) A view to handle puzzle unlocks via POST, handle unlock/solve update requests via AJAX, and render the progress page. Rendering the progress page is extremely data intensive and so the view involves a good amount of pre-fetching. huntserver.staff_views.charts(request) A view to render the charts page. Mostly just collecting and oraganizing data huntserver.staff_views.admin_chat(request) A view to handle chat update requests via AJAX and render the staff chat page. Chat message submissions are sent to huntserver.hunt_views.chat. Chat messages are pre-rendered for both standard and AJAX requests. huntserver.staff_views.hunt_management(request) A view to render the hunt management page huntserver.staff_views.control(request) A view to handle all of the different management actions from staff users via POST requests. This view is not responsible for rendering any normal pages. huntserver.staff_views. s(request) A view to send s out to hunt participants upon recieveing a valid post request as well as rendering the staff form page huntserver.staff_views.depgraph(request) A view to generate and render the puzzle dependency graph visualization 4.4 Auth Views huntserver.auth_views.login_selection(request) A mostly static view to render the login selection. Next url parameter is conserved. huntserver.auth_views.create_account(request) A view to create user and person objects from valid user POST data, as well as render the account creation form. huntserver.auth_views.account_logout(request) A view to logout the user and hopefully also logout out the shibboleth system. huntserver.auth_views.shib_login(request) A view that takes the attributes that the shibboleth server passes back and either logs in or creates a new shibboleth user. The view then redirects the user back to where they were Staff Views 11

14 Chapter 5 How to Create a Hunt Below are all of the steps you should need to take to create a puzzlehunt and have it ready to run: 5.1 Create Hunt Object You aren t going to get very far without a hunt object to attach all of this data to, so sign in with a staff account and navigate over to {server URL}/admin/huntserver/hunt/ Click the Add Hunt button at the top. You will be brought to the hunt creation page, which you should fill out, keeping in mind the following points: Make sure the start date is accurate or at the very least in the future, otherwise people will be able to see your hunt immediately. Make sure the end date is after the start date. Do not check the Is current hunt box just yet See the section below before putting anything into the template editor. Just to be safe, go ahead and click the Save and continue editing before moving onto the next section. 5.2 Edit Hunt Template Basic information This is where we give the hunt it s look and feel. Before this point, navigating to /hunt/{hunt_number} would just give you a blank page. Everything typed into the Template form on the hunt editing page will be run through django s templating engine and rendered as HTML. The following context will be passed to the renderer for use in the template: {'hunt':..., 'puzzles':..., 'team':..., 'solved':...} where hunt is the current hunt object, puzzles is the list of puzzle objects that the team has currently unlocked, team is the team of the user that is viewing the page, and solved is the list of puzzle objects that the team has currently solved. All of those are pretty self explanatory. 12

15 While you may use completely custom HTML, it is STRONGLY RECOMMENDED that you follow the instructions below on how to inherit the base template to get nice features like the header bar, common style sheets, google analytics, and graceful degradation when the hunt becomes public A note about static files As of version 3.0.0, in order to reduce repository clutter, it is now against policy to commit files specific to a certain hunt to the respository. This means that you are no longer allowed to put images, fonts, and other files in /huntserver/static or /static. To still allow the use of new static files in each hunt, a new object class has been created called Hunt Asset Files. This class allows uploading of assets from the web interface, removing the need to interact with the hosting server directly. To upload a new asset file, navigate to {server URL}/admin/huntserver/huntassetfile/ and click the blue Add hunt asset file button at the top. On the following screen, choose the file you wish to upload and hit save. Keep in mind that the URL for the file will be generated based on the uploaded file name and cannot be changed once uploaded, so name your files beforehand. After you upload your file, click the save button and you will be taken back to the list of asset files. Next to each asset file is the link to use in your html template to access that file. It is clear to see that for each file, the link is just /media/hunt/assets/{name of file} Inheriting the base template If you don t already know about how Django template inheritance and blocks work, you can go read up on them here: I promise it won t take too much time to read, isn t too hard to understand, and will make the content below understandable. Now that you know about blocks and inheritance, You ll want to start with the following template code at a minimum: {% extends "hunt_base.html" %} {% block content %} Your content here {% endblock content %} That is the most basic example you can get and will look very bland. Here are some other blocks you can override to get additional custom behavior: title Overriding the title block with whatever content you want to show up in the tab title. The default value for this block is Puzzlehunt! base_includes Overriding the base_includes block will insert content before the standard bootstrap and jquery imports allowing you to override unwanted boostrap styles. The default value for this block only imports hunt_base.css. includes Overriding the includes block will insert content after the standard bootstrap and jquery imports, for content that you want to use to extend those libraries, or content that relies on those libraries. footer Overriding the footer block will insert content at the bottom of the page. The default value is links to our social media and bridge page Edit Hunt Template 13

16 5.2.4 Starter example While you may have all of the information you need, that doesn t mean you know what to do with it. Below is a simple example base upon our first hunt. It will show the puzzles, display the answer for any solved puzzles, and demonstrates how to insert a break a hunt into two rounds. {% extends "hunt_base.html" %} {% block title %}Puzzles!{% endblock title %} {% block base_includes %} <link rel="stylesheet" type="text/css" href="{{ STATIC_URL }}huntserver/hunt_base.css "> <style>.puzzle-name { white-space: nowrap; overflow: hidden; width: 320px; } </style> {% endblock base_includes %} {% block content %} <div class="container" > <div class="row" > <div class="content col-md-6 col-md-offset-3" id='puzzle-frame'> <h1 class="title">puzzlehunt: The Musical</h1> <div id="puzzles"> <table> <thead> <tr> <th style='width: 320px'>Puzzle Name</th> <th style='width: 180px'>Solution?</th> </tr> </thead> <tbody> {% for puzzle in puzzles %} {% if puzzle.puzzle_number == 8 %} </tbody> </table> <h3 class="title">- Intermission -</h3> <table> <tbody> <col width="320px"> <col width="180px"> {% endif %} <tr id='puzzle{{ puzzle.puzzle_number }}' class='puzzle'> <td> <p class="puzzle-name"> <a href='/puzzle/{{ puzzle.puzzle_id }}/'> {{puzzle.puzzle_name}} </a> </p> </td> <td> {% if puzzle in solved %} {{ puzzle.answer upper }} {% endif %} </td> (continues on next page) 5.2. Edit Hunt Template 14

17 </tr> {% endfor %} </tbody> </table> </div> <p> Feeling stuck? <a href="/chat/">chat</a> with us</p> </div> </div> </div> {% endblock content %} (continued from previous page) 5.3 Create Puzzle Objects Great, now we have a hunt template and we can view our hunt, but that s not good without any puzzles, so lets add some. Start by going to {server URL}/admin/huntserver/puzzle/ and clicking the New Puzzle button at the top. You will be brought to the puzzle creation page, which you should fill out, keeping in mind the following points: Puzzle number should ideally be incremental starting at 1, this will be used for ordering puzzles Puzzle ID should be unique across all puzzles ever made, and it is good practice to have the last two digits match the puzzle number Link should be a publicly accessible PDF link (including that doesn t require any authentication to access You don t need to fill in num pages, the server will do that for you upon downloading Num required to unlock represents the number of puzzles in the below list that need to be solved to unlock this puzzle. Any puzzle with a 0 here will be considered part of the initial set Don t worry about Responses right now, we ll talk about that below. After filling out the page, hit Save and add another and continue to add puzzles until you have added all of the puzzles for the hunt. This will take a while, my recommendations are to be patient and have the unlocking graph on hand. 5.4 Create Auto-Response Objects This section is completely optional, but will make your life easier once the hunt is running. At the moment, whenever a user has submitted a correct answer, the server will respond Correct! and whenever the user submits a wrong answer the server will respond Wrong Answer. Often you will want additional customized responses that can do anything from tell the user how they are wrong to tell them to Keep going!. All you have to do is to go back into the edit page for a specific puzzle and enter regexes and response texts in the response boxes at the bottom of the page. Some notes about the responses: Regexes are in python syntax You are allowed to regex upon the correct answer and override the default Correct! response, the puzzle will still be marked as solved 5.3. Create Puzzle Objects 15

18 Regexes are currently applied in no guaranteed order, answer that satisfy more than one regex are considered undefined behavior Response texts are allowed to contain markdown style links: [foo]( 5.5 Update Current Hunt Label Congratulations! You have finished creating a hunt, head over to {server URL}/staff/management/ and click the Set as Current button next to your new hunt. This will cause it to become the hunt represented by the staff pages such as the Progress and Queue pages, it will be displayed on the homepage as the Upcoming hunt, and it will be open to team registration. If any of those sound like things you don t want yet, you can wait as long as you want to set the hunt as the current hunt Update Current Hunt Label 16

19 Chapter 6 How to Run a Hunt So you want to run a puzzlehunt... Below are all of the steps you should need to take to run an already created puzzlehunt: 6.1 Download Puzzles Before anybody can start playing your hunt, you have to download the puzzles. Head over to {server URL}/ staff/management/, make sure the hunt you are trying to run is marked as the current hunt, and click the Fetch ALL puzzles from URLs. It will take a few minutes, be patient. That should just work, if it doesn t, check your links, check your PDF accessibility and try again. (if you really think it is a bug, feel free to submit an issue) 6.2 Playtester Setup You probably want people to test your hunt before the actual event. This is easy using the puzzlehunt server. Just have the team of playtesters sign up like normal, then navigate to {server URL}/admin/huntserver/team/, find the team, check the Playtester checkbox on their edit page, and save the team. They will then have access to the puzzlehunt as if it was open to them. Note: To mimic the exact puzzle experience, they will only have access to puzzles that are unlocked for them, so make sure to head over to the progress page and make sure to unlock their starting puzzles. Like any other team, their progress will be visible on the progress page, their submissions on the queue page, and their messages on the chat page. 6.3 Hunt Start Okay, the hunt is almost ready to happen, you ve downloaded all the puzzles, you ve had people playtest the hunt, and now you re ready to turn it over to the public. Below is a short checklist of items to consider before and during the first few minutes of the event. Before the hunt: 17

20 [ ] Make sure the hunt start time is accurate [ ] Reset all progress from the management page [ ] Ensure all puzzles have working PDFs and images [ ] Ensure all teams have room assignments Start of the hunt: [ ] When you want to release the puzzles, click Release Initial Puzzles from the management page [ ] Ensure that all teams show puzzles as unlocked on the progress page (may take a moment to update) [ ] Have someone watching each of the staff pages (see below) 6.4 Staff Pages / During the Hunt Hopefully your opening information session went well, the puzzles released flawlessly and people are now solving puzzles. Time to sit back and watch/make the magic happen with the help of the following staff pages: Progress page: One of the 2 pages you definitely are going displayed somewhere during the hunt. Some cool features about this page: The number of solved puzzles the team has solved is displayed next to each team The color of each unsolved puzzle for a team will slowly fade from yellow to red the longer they have had the puzzle unlocked but not solved. The last submission time will be visible in the cell for unsolved puzzles The solve time will be visible in the cell for solved puzzles Queue page: The other page you will almost certainly want displayed somewhere during the hunt. Now that all answers are automatically responded to in one way or another upon submission, there is less work to do on this page, but make sure to keep an eye out for teams that need help or have possibly just misspelled something. You can always update the submission response using the Fix link. The new content will be pushed to the team s page automatically. Chat page: It is important to maintain communication with the teams, which is where the chat page comes in. New messages from a team since the page was loaded will make the team s name appear in red. Only teams that have sent a message to the staff will show up on the list. If you absolutely need to send a message to a team who has not contacted staff yet, you can manually do so from the /admin/huntserver/message/ page. Management page: The only thing you would want to do with the management page during the hunt is to update puzzle PDFs. If you find that you need to make a change, simply update the remote PDF content, and fetch the single puzzle with the single puzzle fetch button. The PDF and PNGs should update to match the remote content. page: You can use this to send from the configured to all hunt participants. If you don t trust the interface for some reason or want to send something fancier than plain text, you can click the Click to show all s button to display all hunt participant s and send something manually. Charts page: Everybody likes charts! At the moment, we have the following charts: Graph of number of teams that have any given puzzle locked, unlocked or solved Graph of correct vs incorrect submissions for all puzzles 6.4. Staff Pages / During the Hunt 18

21 Graph of submissions over time during the hours that the hunt was open Graph of solves over time during the hours that the hunt was open 6.5 Hunt End The hunt is nearing completion, hopefully everything went well and enough teams have completed the hunt to satisfy you. If you think the hunt hasn t run long enough, be sure to update the hunt end time before you reach it. Once the hunt end time is reached, all puzzles will be available for the public and all hunt interfaces will update to indicate that the hunt is over Hunt End 19

22 Chapter 7 Changelog 7.1 Version v3.1.1 Updates: Updated documentation to include instructions for hunt asset files v3.1.0 New: Users can now update their profile information including name, , phone, and food preferences Teams can now update their own location from the registration page Automatic submission responses now support markdown style links Progress page now has a button to unlock a specific puzzle for all teams New 404 and 500 error pages to match website s style Updates: Removed unlockables tab from hunt header due to disuse Progress and Queue page now have sleeker more compact look Hunt info page now pulls max team size from database Contact us page now has more contact info Unused /staff URLs will now route to /admin URLs Bugfixes: Fixed bug where team names could be made entirely of whitespace characters Removed dummy teams from all normal hunt interactions Fixed bug where parts of old hunt headers lead to the current hunt pages Fixed bug where staff announcements triggered new message alert for other staff members. 20

23 Fixed bug in relating to the use of is not None in info_views v3.0.3 New: Documentation of models, views, configuration, and how to run the server v3.0.2 Bugfixes: Fixed bug where chat would throw an error if the hunt did not have any messages yet Fixed bug where sometimes staff chat button remapping script wouldn t load v3.0.1 Bugfixes: Fixed bug where staff had to have puzzle unlocked to view puzzle v3.0.0 New: Staff interaction with server via SSH is no longer necessary for normal hunt creation The template for each puzzlehunt is now editable from an web-based inline editor * The editor is located on the admin page for each hunt * The editor supports syntax highlighting for HTML and CSS * HTML files in the template folder of the form hunt#.html are now useless Hunt-specific web assets such as fonts and images can now be uploaded from admin interface * Assets are stored in the /media/hunt/assets/ directory Hunt specific files should no longer be included in the repository 7.2 Older Versions You can find the changelog for older versions in the online documentation at Older Versions 21

24 Chapter 8 Contribute Source Code: Issue Tracker: If you are having issues, please let us know. dlareau@cmu.edu The project is licensed under the MIT license. 22

25 Index A account_logout() (in module huntserver.auth_views), 11 admin_chat() (in module huntserver.staff_views), 11 C charts() (in module huntserver.staff_views), 11 chat() (in module huntserver.hunt_views), 10 control() (in module huntserver.staff_views), 11 create_account() (in module huntserver.auth_views), 11 current_hunt() (in module huntserver.hunt_views), 10 current_hunt_info() (in module huntserver.info_views), 10 D depgraph() (in module huntserver.staff_views), 11 E s() (in module huntserver.staff_views), 11 G get_available_name() (huntserver.models.overwritestorage method), 6 H Hunt (class in huntserver.models), 5 hunt() (in module huntserver.hunt_views), 10 Hunt.DoesNotExist, 5 Hunt.MultipleObjectsReturned, 5 hunt_management() (in module huntserver.staff_views), 11 HuntAssetFile (class in huntserver.models), 5 HuntAssetFile.DoesNotExist, 6 HuntAssetFile.MultipleObjectsReturned, 6 huntserver.models (module), 5 I index() (in module huntserver.info_views), 10 is_correct (huntserver.models.submission attribute), 8 is_locked (huntserver.models.hunt attribute), 5 is_normal_team (huntserver.models.team attribute), 8 is_open (huntserver.models.hunt attribute), 5 is_playtester_team (huntserver.models.team attribute), 8 is_public (huntserver.models.hunt attribute), 5 L login_selection() (in module huntserver.auth_views), 11 M Message (class in huntserver.models), 6 Message.DoesNotExist, 6 Message.MultipleObjectsReturned, 6 O OverwriteStorage (class in huntserver.models), 6 P Person (class in huntserver.models), 6 Person.DoesNotExist, 6 Person.MultipleObjectsReturned, 6 previous_hunts() (in module huntserver.info_views), 10 progress() (in module huntserver.staff_views), 11 protected_static() (in module huntserver.hunt_views), 10 Puzzle (class in huntserver.models), 6 Puzzle.DoesNotExist, 7 Puzzle.MultipleObjectsReturned, 7 puzzle_view() (in module huntserver.hunt_views), 10 Q queue() (in module huntserver.staff_views), 11 R registration() (in module huntserver.info_views), 10 Response (class in huntserver.models), 7 Response.DoesNotExist, 7 Response.MultipleObjectsReturned, 7 S serialize_for_ajax() (huntserver.models.puzzle method), 7 serialize_for_ajax() (huntserver.models.solve method), 7 serialize_for_ajax() (huntserver.models.submission method), 8 23

26 shib_login() (in module huntserver.auth_views), 11 Solve (class in huntserver.models), 7 Solve.DoesNotExist, 7 Solve.MultipleObjectsReturned, 7 Submission (class in huntserver.models), 7 Submission.DoesNotExist, 8 Submission.MultipleObjectsReturned, 8 T Team (class in huntserver.models), 8 Team.DoesNotExist, 8 Team.MultipleObjectsReturned, 8 U Unlock (class in huntserver.models), 8 Unlock.DoesNotExist, 9 Unlock.MultipleObjectsReturned, 9 Unlockable (class in huntserver.models), 9 Unlockable.DoesNotExist, 9 Unlockable.MultipleObjectsReturned, 9 unlockables() (in module huntserver.hunt_views), 10 user_profile() (in module huntserver.info_views), 11 Index 24