ITEC 325 2014spring ibarland

home—lects—hws
D2L—breeze (snow day)

hw03
sanitized html
and automated source-listings

Scenario

You are working for Lizard Entertainment, makers of the popular adventure game, .World of Wowcraft (“.W.o.W.”). In .W.o.W., players choose a type of character: either warrior, mage, priest, or rogue. Over the course of the game, their characters can learn various skills, depending on type: For example, the diplomacy skill (which is learnable only by rogues and priests), or the acrobatics skill (which is learnable only by rogues and warriors), etc.. Each skill is be tied to one of six built-in character traits: Strength, Intelligence, Wisdom, Dexterity, Constitution, and Charisma. Finally, each skill has a minimum-level (between 30 and 100 inclusive).

Your boss decides that a key feature of the game is that people can add their own skills to the game. Your job is to build a web-page that lets people enter new skills for the game to use. People will enter the name of the skill, a detailed description, which character-types can use it, what trait it's tied to, and their own name (to get the glory). When they submit their form, they will see a response page summarizing the information they entered.

An example of filling out the form	The result of the processing the form

Your Task

For this homework: Make a web-form at https://php.radford.edu/~yourUserName/itec325/hw03/skill-form.php which submits to skill-handle.php.

1. When printing values taken from the form, sanitize the HTML. A user should be able to enter (say) a description which includes characters like < and ' and newlines, and the resulting summary should show the same string as whas was entered, up to whitespace. (However, do show linebreaks, in the skill-description.)

   Note that the checkboxes in skill-form.php should all have the same name attribute (and it should end in “[]”), so that you can retrieve it as an array in your form.

2. Your file hw03/index.php should show all the files in your solution.

   The page does need to contain (near the top) your name, a link to your skill-form, a link to this homework-assignment, and a “table of contents” — a list of links to later in the page, with the detailed information for each file.

   TODO: Ian, show example.

   The source should be shown only if the current time is between 2014-Mar-07 23:59 and 2014-May-31 23:59; otherwise show a message along of the lines of “source code only available between 2014-Mar-07 23:59 and 2014-May-31 23:59.”

3. Call the function show_file_info below, along with scandir, to show all the files in your directory.

4. Required functions (w/ test cases, except as noted):

   • (20pts) Write a function which takes in an array of strings (checkbox-descriptions) (and, a group-name), and returns a string that happens to be valid html for a series of checkboxes. The string should include newlines, and (if you want) each line might start with (say) 6 spaces, to serve as indentation.

     For example, calling checkboxes( 'family', array('Brother', 'Sister', 'Pet') ) would return html which renders as something like:
     Brother
     Sister
     Pet
     
     Include at least two test cases; you'll probably want to write a sample series of checkboxes by hand, to serve as your expected-output. Use label tags to group each checkbox with its adjacent text.

   • (10pts) Include a function named (something like) arrayToHTML_table, which takes in an array and returns a string: the HTML markup for a two-column table, with the array-indices in the first column and the array-values in the second.

     For example, arrayToHTML_table( array( "en" => "Hi", "de" => "'Tag", "fr" => "'Allo" ) ) should return HTML which renders as something like:

     en	Hi
     de	'Tag
     fr	'Allo

     Include at least two test cases. I suggest first writing the raw html for the table, and then cutting/pasting that html in as the expected-result; this will help you decide what whitespace etc. you want your function to produce.

   • A function dropdown which takes in an array of strings (and any other necessary arguments), and returns a string of HTML for a drop-down menu, using the provided strings as choices in the menu, but their keys as the each option's value attribute.

   • A function show_file_info, which takes in an a filename, start-time, and end-time, and it prints (not returns) the filename (fairly emphasized, and also as a link to the file itself — call your function hyperlink), the last-modified date, and the result of calling show_source_between (see below) appropriately. You may include further information or HTML formatting/styling, as you like, to make the output render more effectively.

     No test cases required — this function prints, and does not return anything.

   • You of course are welcome to have further utility/helper functions as you like. (In particular, I can think of one more task that is part of this assignment, and is also a stand-alone task that will be re-usable in future assignments or in other contexts.)

5. I am providing a file utils.php (and its tests utils-test.php) which contains a function show_source_between, which takes in a filename, start-time and end-time, and it prints (not returns) the file's source if it's currently between the selected times, or else a message stating when the solutions were/will-be available. See show_source.

   No test cases required — this function prints, and does not return anything.

6. I am providing a file utils.php (and its tests utils-test.php) which contains a function testAsHTML testUpToWhitespace, which compares an actual and expected output, ignoring most whitespace.

I will visit the URL https://php.radford.edu/~yourUserName/itec325/hw03/index.php to grade your work. If that URL is not accessible, you will get a 0 for that portion of the grading!

Other requirements

• Each file start should start with with a PHP or HTML comment with your name, class, etc. (after a doctype declaration and perhaps <html>).
• Use meaningful variable names, function names, and good comments as needed.
• Write functions (both php and javascript) as appropriate, to avoid repeated work.
  I recommend writing functions that return strings rather than print (as convenient¹), and including one or two test-cases as examples. Writing the test-case first often clarifies exactly what your code needs to return.
• Use standard XHTML tags and make sure any javascript does not use browser-specific constructs.
• All code/html should be well formatted with appropriate white space and indentation so it is easy to read.
• Strive to minimize lines that wrap.
• If you have any questions, use the discussion board.
• Do not modify your final submission after the due-date; if you want to make changes, copy all your files to a new directory and work on those. (Linux: use cp -pr to preserve timestamps and copy directories recursively.)

• Please run/check your program/html incrementally — don't write huge amounts of the assignment w/o even running it.

home—lects—hws
D2L—breeze (snow day)

©2014, Ian Barland, Radford University Last modified 2014.Mar.01 (Sat)

Please mail any suggestions (incl. typos, broken links) to ibarlandradford.edu