Package edu.wisc.game.rest

Class Files

  • public class Files
extends Object
    Information about the data files the Rule Game web server reads and writes. The former are the experiment control files; the latter contain the record of the system's interactions with the players (transcripts, initial boards, players' responses to questionnaires, etc).

    • Constructor Detail

      • Files

        public Files()

    • Method Detail

      • setInputDir

        public static void setInputDir​(String path)
        Sets the path to the input directory, which is the root of the tree that contains the experiment control files. You only need to use this method if you want trial list files, rule set files, etc. to be read from directories in a directory tree other than the default ("/opt/w2020/game-data", or on older systems "/opt/tomcat/game-data"). So, for example, the Captive Game Server may use this method. If you use it, do so early in your application.
        Parameters:
        path - E.g. "/opt/w2020/game-data"

      • savedSubDir

        public static File savedSubDir​(String subdir)
        A specific subdirectory of the saved-files directory

      • guessesFile

        public static File guessesFile​(String playerId)
                        throws IOException
        The file into which guesses by a given player are written
        Throws:
        IOException

      • boardsFile

        public static File boardsFile​(String playerId)
                       throws IOException
        The file into which the initial boards of all episodes played by a given player are written
        Throws:
        IOException

      • shapesDir

        public static File shapesDir()

      • mlcUploadDir

        public static File mlcUploadDir​(String nickname,
                                boolean readOnly)
                         throws IOException
        The upload directory for a particular MLC participant. It is created if it does not exist yet
        Throws:
        IOException

      • rulesFile

        public static File rulesFile​(String ruleSetName)
                      throws IOException
        Parameters:
        ruleSetName - Either a complete absolute path name ("/home/vmenkov/foo.txt") starting with a slash, or just a file name without the extension ("foo"). In the later case, the file is assumed to be in the standard rules directory.
        Throws:
        IOException

      • allowCachingAllRules

        public static void allowCachingAllRules​(boolean x)
        This can be used (typically, in the captive server context) to allow caching all rules, for greater efficiency

      • rulesCanBeCached

        public static boolean rulesCanBeCached​(String ruleSetName)
        Can the game server cache this rule set? The convention is, names not starting with a slash refer to files in the tomcat directory, whose content is supposed to be stable; therefore, they can be cached in the web app. Names starting with a slash are interpreted as absolute paths of files, presumably belonging to developers and thus possibly not stable; so the game server does not cache those.

      • inputBoardSubdir

        public static File inputBoardSubdir​(String boardSubdirName)
                             throws IOException
        A subdirectory of the input boards directory, for use in a param set with initial boards
        Throws:
        IOException

      • getSvgFile

        public static File getSvgFile​(String shape)
        Parameters:
        shape - Case-insensitive shape name, e.g. "circle", or "arrows/up". To obtain the SVG file name, the shape name is converted to lower case, and ".svg" is added.

      • getImageFile

        public static File getImageFile​(String shape)
        Looks for an image file with an appropriate name in the shapes directory.
        Returns:
        A File object if a file has been found, or null otherwise

      • listSAllExperimentPlans

        public static String[] listSAllExperimentPlans()
                                        throws IOException
        List all existing experiment plans (based on the directory names in the appropriate tree). Excludes obviously "bad" plans (those without the rule set files, for example).
        Throws:
        IOException

      • listSAllExperimentPlans

        public static String[] listSAllExperimentPlans​(boolean validOnly)
                                        throws IOException
        Parameters:
        validOnly - If true, excludes obviously "bad" plans (those without the rule set files, for example).
        Throws:
        IOException

      • listAllRuleSetsInTree

        public static String[] listAllRuleSetsInTree​(String s)
                                      throws IOException
        Lists all rule sets under rules/s
        Parameters:
        s - The position of the root of the tree relative to the main rules directory
        Returns:
        A list of proper rule set names (in the same format they would be likely to be encountered in trial list files, i.e. path names (relative to "rules") without extension.
        Throws:
        IOException

      • listSAllExperimentPlansHtml

        public static String listSAllExperimentPlansHtml()
                                          throws IOException
        Creates an HTML snippet (to be used inside a FORM, e.g. at front-end-form.jsp) listing all currently existing experiment plans.
        Throws:
        IOException

      • listSAllExperimentPlansHtml

        public static String listSAllExperimentPlansHtml​(boolean validOnly)
                                          throws IOException
        Throws:
        IOException

      • getLaunchFileA

        public static File getLaunchFileA​(LaunchRulesBase.Mode mode)
        The control file for the repeat-user launch page
        Parameters:
        mode - APP, MLC, etc

      • pregameDir

        public static File pregameDir​(String pregame)
                       throws IOException
        The directory where the bundle pregame experience files is stored for a specific experience name
        Throws:
        IOException

      • geminiDir

        public static File geminiDir()

      • condFile

        public static File condFile​(String condFileName)
                     throws IOException
        Parameters:
        condFileName - Relative to /opt/w2020/game-data/cond
        Throws:
        IOException