generate.ss web-export.ss @@ -1,7 +1,7 @@ #lang scheme/base (require (file "util.scm") - (planet "web.scm" ("soegaard" "web.plt" 2 1)) + "web-export.ss" (file "web-support.scm") (file "settings.scm")) closures.scm @@ -2,17 +2,18 @@ ;; A PLT Scheme interface to the Facebook API. ;; NOT READY FOR USE YET! Just a preliminary checkin... +;; (One reason this isn't ready is that you have to hack dherman's json.plt planet lib +;; to get this to work.) (require (file "settings.scm") (file "util.scm") "contract-lp.ss" + "web-export.ss" (file "web-support.scm") "page.scm" "form.scm" "util.scm" "js.scm" - (planet "web.scm" ("soegaard" "web.plt" 2 (= 1))) - web-server/private/request-structs ; should be ... web-server/http/request-structs (only-in (planet "json.ss" ("dherman" "json.plt" 1 (= 1))) (read read-json))) (provide facebook-fn facebook.ss @@ -3,11 +3,11 @@ (require "time.scm" "util.scm" "contract-lp.ss" + "web-export.ss" "web-support.scm" "settings.scm" - "page.scm" - (planet "web.scm" ("soegaard" "web.plt" 2 (= 1))) - (planet "uuid-v4.ss" ("zitterbewegung" "uuid-v4.plt" 1 0))) + "page.scm") + ; xxx used? (planet "uuid-v4.ss" ("zitterbewegung" "uuid-v4.plt" 1 0))) (provide ;; atom-feed (via contract) ;; atom-item (via contract) feed.ss @@ -7,7 +7,6 @@ (file "web-support.scm") (file "files.scm") "settings.scm" - (planet "web.scm" ("soegaard" "web.plt" 2 1)) (lib "url.ss" "net")) (provide form form.scm @@ -7,34 +7,18 @@ (require "util.scm" (only-in mzlib/file normalize-path)) -(provide generate generate-from-path) +(provide generate-project) -(define PLANET_MAJOR_VERISON 3) +(define PLANET_MAJOR_VERISON 4) (define PLANET_MINOR_VERSION 0) -(define (generate args-vec) - (generate-from-args-list (vector->list args-vec))) +(define (generate-project cmd-line-args-vec) + (match cmd-line-args-vec + ((vector project-path) + (generate-project-from-path project-path)) + (else (e "You must provide exactly one argument to generate--a path to a new project directory.")))) -(define (generate-from-path project-path args-vec) - (generate-from-args-list (cons-to-end project-path (vector->list args-vec)))) - -;; Note: in order for this to work with generate-from-path, you need to make sure that -;; for every command, the last argument is always the project path. -(define (generate-from-args-list args) - (match args - ((list "project" fresh-project-path) - (generate-project-dir fresh-project-path)) - ((list "script" project-path) - (generate-script-dir project-path)) - ((list "scm" project-path) - (generate-basic-scm-files project-path)) - ((list project-path) - (e "You need to provide a command to the generate script.")) - ((list-rest command rst) - (e "Generate command \"~A\" not understood." command)) - (else (e "Generate expression \"generate ~A\" not understood." args)))) - -(define (generate-project-dir fresh-project-path) +(define (generate-project-from-path fresh-project-path) (if (directory-exists? fresh-project-path) (e "The directory ~A already exists." fresh-project-path) (begin (ensure-existence-of-dir! fresh-project-path) @@ -45,7 +29,8 @@ (ensure-existence-of-dir! (build-path fresh-project-path "htdocs/js")) (ensure-existence-of-dir! (build-path fresh-project-path "htdocs/i")) (generate-basic-scm-files fresh-project-path) - (generate-script-dir fresh-project-path)))) + (generate-script-dir fresh-project-path) + (generate-htdocs-files fresh-project-path)))) (define (generate-basic-scm-files project-path) ;; serve.scm @@ -58,12 +43,9 @@ (make-raw "") '(load-server-settings) (make-raw "") - '(serve my-app - #:listen-ip (setting *LISTEN_IP*) - #:port (setting *PORT*) - #:htdocs-path '("htdocs")) + '(serve my-app) ) - + ;; app.scm (generate-file-with-expressions #:dir-must-exist #t @@ -111,6 +93,12 @@ ) +(define (generate-htdocs-files project-path) + (ensure-existence-of-dir! project-path #:must-previously-exist #t) + (generate-file-with-expressions + (build-path project-path "htdocs/page-not-found.html") + (make-raw "<html><body>Page not found.</body></html>"))) + (define-struct raw (str)) (define (generate-file-with-expressions path-to-file @@ -134,7 +122,7 @@ (e "The directory ~A cannot be found." dir-path)) (or (directory-exists? dir-path) (begin (make-directory dir-path) - (display (format "Created directory ~A.\n" dir-path)))))) + (display (format "Created directory ~A\n" dir-path)))))) ;; it's an error if filename in path already exists (define (with-output-to-file-in-dir path-to-file thunk @@ -146,8 +134,3 @@ (define (expr-for-lp-require filename-rel-to-lib-root) `(planet ,filename-rel-to-lib-root ("vegashacker" "leftparen.plt" ,PLANET_MAJOR_VERISON ,PLANET_MINOR_VERSION))) - -;; consumes a (maybe relative) project-path -;; XXX rid? -;;(define (absolute-project-path-str project-path) -;; (path->string (normalize-path (build-path project-path)))) generate-lib.scm @@ -1,11 +1,13 @@ #lang scheme/base (require scheme/match - (planet "web.scm" ("soegaard" "web.plt" 2 1)) - (planet "instaservlet.ss" ("untyped" "instaservlet.plt" 1 7)) - (planet "dispatch.ss" ("untyped" "dispatch.plt" 1 5)) + (planet untyped/dispatch:1:7/dispatch) + web-server/servlet-env + web-server/dispatchers/dispatch + web-server/configuration/responders "util.scm" "settings.scm" + "web-export.ss" "web-support.scm" "record.scm" "repository.scm" @@ -22,15 +24,13 @@ "log.scm" "task-queue.scm" "feed.ss" + "facebook.ss" ) (provide ;; the work of others: - (except-out (all-from-out (planet "web.scm" ("soegaard" "web.plt" 2 1))) - comment? redirect-to) ; we use our own modification of redirect-to - (all-from-out (planet "dispatch.ss" ("untyped" "dispatch.plt" 1 5))) - (all-from-out (planet "instaservlet.ss" ("untyped" "instaservlet.plt" 1 7))) + (all-from-out (planet untyped/dispatch:1:7/dispatch)) ;; web server serve @@ -200,37 +200,56 @@ task-inspector-lock task-inspector-num-tasks-thunk + ;; facebook + facebook-fn + define-facebook-required-login-page + facebook-require-login + facebook-session-key + facebook-error + facebook-uid + facebook-form + facebook-complex-val + facebook-create-object + facebook-strict-error ) (declare-setting *APP_VERSION* 1) - +(declare-setting *PAGE_NOT_FOUND_FILE* "page-not-found.html") (declare-setting *CATCH-EXCEPTION?* (lambda (exn) #t)) (declare-setting *EXCEPTION->XEXPR* (lambda (exn) - ((error-display-handler) (exn-message exn) exn) - "Page not found.")) - -;; consumes a web-app; passes its keyword arguments to go! (part of instaservlet) -(define serve - (make-keyword-procedure - (lambda (kws kw-vals . reg-args) - (match reg-args - ((list) - (e "The serve function requires you to pass an app as the first argument.")) - ((list web-app) - (begin - (populate-caches) - (keyword-apply go! - kws - kw-vals - (list (lambda (req) - (let ((catch? (setting *CATCH-EXCEPTION?*)) - (err (setting *EXCEPTION->XEXPR*))) - (with-handlers ((catch? err)) - (final-prep-of-response - (handle-closure-in-req - req - (dispatch req web-app)))))))))))))) + (if (exn:dispatcher? exn) + ;; then it really just means that dispatch + ;; failed to find an appropriate URL match, so we + ;; need to look for static files: + (next-dispatcher) + ;; otherwise, it is an actual error... + (begin + ((error-display-handler) + (exn-message exn) exn) + "Error on page.")))) +(define (serve web-app) + (populate-caches) + (server-log "Server is ready at ~A (ctrl-c to stop it)." (setting *WEB_APP_URL*)) + (serve/servlet #:command-line? #t + #:launch-browser? #f + #:servlet-path "/" + #:server-root-path (build-path ".") + #:servlet-regexp #rx"" + #:file-not-found-responder + (gen-file-not-found-responder (build-path + "htdocs" + (setting *PAGE_NOT_FOUND_FILE*))) + #:listen-ip (setting *LISTEN_IP*) + #:port (setting *PORT*) + (lambda (req) + (let ((catch? (setting *CATCH-EXCEPTION?*)) + (err (setting *EXCEPTION->XEXPR*))) + (with-handlers ((catch? err)) + (final-prep-of-response + (handle-closure-in-req req + (dispatch req web-app)))))))) + (define-syntax define-app (syntax-rules () ((_ app-name leftparen.scm @@ -1,10 +1,10 @@ #lang scheme/base (require net/url - (planet "dispatch.ss" ("untyped" "dispatch.plt" 1 5)) - (planet "web.scm" ("soegaard" "web.plt" 2 1)) + (planet untyped/dispatch:1:7/dispatch) (planet "digest.ss" ("soegaard" "digest.plt" 1 1)) "util.scm" + "web-export.ss" "web-support.scm" "session.scm" "settings.scm" page.scm @@ -1,5 +1,5 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html><head><meta http-equiv="content-type" content="text-html; charset=utf-8" /><title>LeftParen 0.4 Documentation</title><link rel="stylesheet" type="text/css" href="scribble.css" title="default" /><script type="text/javascript" src="scribble-common.js"></script></head><body><div class="tocset"><div class="tocview"><div class="tocviewlist" style="margin-bottom: 1em;"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><a href="file:///Users/rob/Documents/git-leftparen/scribblings/leftparen.html" class="tocviewselflink">Left Paren 0.4 Documentation</a></td></tr></table></div><div class="tocviewsublistonly" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="file:///Users/rob/Documents/git-leftparen/scribblings/leftparen.html#(part._.Installing_.Left.Paren)" class="tocviewlink">Installing Left Paren</a></td></tr><tr><td align="right">2 </td><td><a href="file:///Users/rob/Documents/git-leftparen/scribblings/leftparen.html#(part._tutorials)" class="tocviewlink">Tutorials</a></td></tr><tr><td align="right">3 </td><td><a href="file:///Users/rob/Documents/git-leftparen/scribblings/leftparen.html#(part._.Reference)" class="tocviewlink">Reference</a></td></tr><tr><td align="right">4 </td><td><a href="file:///Users/rob/Documents/git-leftparen/scribblings/leftparen.html#(part._.About_.Acknowledgements)" class="tocviewlink">About/ Acknowledgements</a></td></tr></table></div></div></div><div class="tocsub"><table class="tocsublist" cellspacing="0"><tr><td>1<tt> </tt><a href="#(part._.Installing_.Left.Paren)" class="tocsubseclink">Installing Left Paren</a></td></tr><tr><td>2<tt> </tt><a href="#(part._tutorials)" class="tocsubseclink">Tutorials</a></td></tr><tr><td>2.1<tt> </tt><a href="#(part._.Hello__.World)" class="tocsubseclink">Hello, World</a></td></tr><tr><td>2.2<tt> </tt><a href="#(part._.Blogerton_the_.Blog)" class="tocsubseclink">Blogerton the Blog</a></td></tr><tr><td>2.2.1<tt> </tt><a href="#(part._.Changes_to_app_scm)" class="tocsubseclink">Changes to app.scm</a></td></tr><tr><td>2.2.2<tt> </tt><a href="#(part._.Changes_to_main_scm)" class="tocsubseclink">Changes to main.scm</a></td></tr><tr><td>2.2.3<tt> </tt><a href="#(part._.Launch_.Blogerton)" class="tocsubseclink">Launch Blogerton</a></td></tr><tr><td>3<tt> </tt><a href="#(part._.Reference)" class="tocsubseclink">Reference</a></td></tr><tr><td>3.1<tt> </tt><a href="#(part._.Forms)" class="tocsubseclink">Forms</a></td></tr><tr><td>3.1.1<tt> </tt><a href="#(part._.Image_uploads)" class="tocsubseclink">Image uploads</a></td></tr><tr><td>3.2<tt> </tt><a href="#(part._.Sessions)" class="tocsubseclink">Sessions</a></td></tr><tr><td>3.2.1<tt> </tt><a href="#(part._.Creating_sessions)" class="tocsubseclink">Creating sessions</a></td></tr><tr><td>3.2.2<tt> </tt><a href="#(part._.Accessing_sessions)" class="tocsubseclink">Accessing sessions</a></td></tr><tr><td>3.3<tt> </tt><a href="#(part._.Users)" class="tocsubseclink">Users</a></td></tr><tr><td>3.4<tt> </tt><a href="#(part._.Feeds)" class="tocsubseclink">Feeds</a></td></tr><tr><td>4<tt> </tt><a href="#(part._.About_.Acknowledgements)" class="tocsubseclink">About/ Acknowledgements</a></td></tr><tr><td>4.1<tt> </tt><a href="#(part._.Contributors)" class="tocsubseclink">Contributors</a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="versionbox">Version: 4.1.0.3</div><div class="navset" style="margin-bottom: 2em; border-bottom: 2px solid #e0e0c0;"><input style="width: 16em; margin: 0px; padding: 0px; background-color: #eee; color: #888; border: 1px solid #ddd; text-align: center; vertical-align: middle;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "4.1.0.3", "");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }" />   </div><h2><a name="(part._.Left.Paren_0_4_.Documentation)"></a>LeftParen 0.4 Documentation</h2>Website: <a href="http://leftparen.com">http://leftparen.com</a>LeftParen is a framework for quickly creating web apps. It runs on -PLT Scheme v4.1 or greater. LeftParen is released under an <a href="http://github.com/vegashacker/leftparen/tree/master/MIT-LICENSE.txt">MIT License</a>. The source is available on <a href="http://github.com/vegashacker/leftparen/tree/master">github</a>.<h3>1<tt> </tt><a name="(part._.Installing_.Left.Paren)"></a>Installing LeftParen</h3>You’ll need PLT Scheme v4.1 or greater installed.Make sure that mzscheme is in your path. You should be ready -to go if you can do this:<table cellspacing="0"><tr><td>% mzscheme</td></tr><tr><td>Welcome to MzScheme v4.1...</td></tr><tr><td>></td></tr></table>Installing LeftParen is done behind the scenes with a <a href="http://planet.plt-scheme.org/">PLaneT</a> require. See <a href="file:///Users/rob/Documents/git-leftparen/scribblings/leftparen.html#(part._tutorials)">Tutorials</a> for an example of this. When you -first issue one of these require commands, you’ll automatically download the LeftParen files to your local PLaneT cache. This can sometimes take a few moments, so be prepared to wait a bit.<h3>2<tt> </tt><a name="(part._tutorials)"></a>Tutorials</h3><h4>2.1<tt> </tt><a name="(part._.Hello__.World)"></a>Hello, World</h4>We’re going to make a project called hello-world. Change to the directory that you’d like to make the project in. Then issue<table cellspacing="0"><tr><td>% mzscheme -e '(require (planet "bootstrap.scm" ("vegashacker" "leftparen.plt" 3 0)))' project hello-world</td></tr></table>This will create a hello-world project directory for you. In this directory you’ll find the script directory, which contains some useful scripts. All paths are relative to this project directory, so when calling scripts, you always want to be at the project root.<table cellspacing="0"><tr><td>% cd hello-world</td></tr></table>We need to make the scripts executable:<table cellspacing="0"><tr><td>% chmod u+x script/*</td></tr></table>LeftParen has automatically generated everything we need to run our web app – we just need to start the server (again, you should be at the project root directory):<table cellspacing="0"><tr><td>% ./script/server</td></tr><tr><td>Web server started on port 8765</td></tr><tr><td>Listening on IP address: 127.0.0.1</td></tr><tr><td>Type stop to stop the server and exit</td></tr><tr><td>Type restart to restart the server</td></tr></table>Point your browser to <a href="http://localhost:8765">http://localhost:8765</a> and you should see a familiar greeting:Hello, World!<h4>2.2<tt> </tt><a name="(part._.Blogerton_the_.Blog)"></a>Blogerton the Blog</h4>Now let’s try implementing the true "hello world" of web apps – a blog. First, execute the following commands from the directory in which you want to create your project directory:<table cellspacing="0"><tr><td>% mzscheme -e '(require (planet "bootstrap.scm" ("vegashacker" "leftparen.plt" 3 0)))' project blogerton</td></tr><tr><td>% cd blogerton</td></tr><tr><td>% chmod u+x script/*</td></tr></table><h5>2.2.1<tt> </tt><a name="(part._.Changes_to_app_scm)"></a>Changes to app.scm</h5>We need to register a couple of pages in our app. The index-page was already set up for you, but you’ll need to add a page to create new posts, and one to view them. Make the define-app call look like this:<table cellspacing="0" class="schemeblock"><tr><td>  (define-app my-app</td></tr><tr><td>    (index-page (url "/"))</td></tr><tr><td>    (create-post-page (url "/post"))</td></tr><tr><td>    (view-post-page (url "/view/" (string-arg))))</td></tr></table><h5>2.2.2<tt> </tt><a name="(part._.Changes_to_main_scm)"></a>Changes to main.scm</h5>Now we need to define those pages that we declared in app.scm.<table cellspacing="0" class="schemeblock"><tr><td>  (define-page (index-page req)</td></tr><tr><td>    (** `(h1 "Blogerton")</td></tr><tr><td>        `(p ,(web-link "Create a new post" (page-url create-post-page)))</td></tr><tr><td>        `(ul ,@(map (lambda (p) `(li ,(paint-blog-post p)))</td></tr><tr><td>                    (load-where '((type . blog-post))</td></tr><tr><td>                                #:sort-by 'created-at #:compare >)))))</td></tr><tr><td>  </td></tr><tr><td>  (define-page (create-post-page req)</td></tr><tr><td>    (form '((title "Title" text) (body "Body" long-text))</td></tr><tr><td>          #:init '((type . blog-post))</td></tr><tr><td>          #:on-done (lambda (post) (redirect-to-page view-post-page (rec-id post)))))</td></tr><tr><td>  </td></tr><tr><td>  (define-page (view-post-page req post-id)</td></tr><tr><td>    (paint-blog-post (load-rec post-id #:ensure '((type . blog-post)))))</td></tr><tr><td>  </td></tr><tr><td>  (define (paint-blog-post post)</td></tr><tr><td>    `(div (h2 ,(rec-prop post 'title))</td></tr><tr><td>          (p ,(rec-prop post 'body))))</td></tr></table><h5>2.2.3<tt> </tt><a name="(part._.Launch_.Blogerton)"></a>Launch Blogerton</h5>You’re ready for launch. Start the server with<table cellspacing="0"><tr><td>% ./script/server</td></tr></table>and you should have a basic blogging app, with persistent data, in 19 lines of code.<h3>3<tt> </tt><a name="(part._.Reference)"></a>Reference</h3><h4>3.1<tt> </tt><a name="(part._.Forms)"></a>Forms</h4>Most web applications make some use of web forms. The form function lets easily you get and process input from your users.<table cellspacing="0" class="boxed"><tr><td>(form field-specs) → xexpr?</td></tr><tr><td>  field-specs : (listof field-spec?)</td></tr></table><table cellspacing="0" class="boxed"><tr><td>field-spec? : (list symbol? string? field-type?)</td></tr></table><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="argcontract"><tr><td>field-type? : </td><td><table cellspacing="0" class="schemeblock"><tr><td>(or/c 'text 'long-text 'number 'password 'image 'checkbox</td></tr><tr><td>      'radio 'drop-down)</td></tr></table></td></tr></table></td></tr></table>You create a form by listing, in order, "field specifications". For example, you might want a title field, followed by a description text box, followed by a photo upload field. Note that the many keyword arguments available to the form function aren’t documented yet.Each field spec is of the form (field-name label field-type). For example, you create a title field, you might use the spec (title "Enter a title" text). The entire example metioned above might look like this:<table cellspacing="0" class="schemeblock"><tr><td>  (form '((title "Title" text)</td></tr><tr><td>          (description "Description" long-text)</td></tr><tr><td>          (photo "Your photo" image)))</td></tr></table><h5>3.1.1<tt> </tt><a name="(part._.Image_uploads)"></a>Image uploads</h5>By default, uploaded images are stored in the uploaded-files directory in your project directory. You can customize this with the *PATH_TO_UPLOADED_FILES* setting. When images are saved, their original filenames are used with a 5-character code pre-pended to make filenames unique.<h4>3.2<tt> </tt><a name="(part._.Sessions)"></a>Sessions</h4>A session is an object that allows you to easily store state about individual visitors to your web app. Sessions are stored on the server as a record with a virtually impossible-to-guess id. A cookie is left in the user’s web browser, which contains a pointer to a particular session id. These cookies expire one month after creation and, currently, this can’t be changed.<h5>3.2.1<tt> </tt><a name="(part._.Creating_sessions)"></a>Creating sessions</h5><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="schemeblock"><tr><td>(define-session-page</td></tr><tr><td>  (page-name request-iden session-iden page-args ...)</td></tr><tr><td>  body ...)</td></tr></table></td></tr></table>This is an alternate to define-page, most commonly used in main.scm. The only difference is that after the request identifier, you must provide a session identifier. For example, to keep a counter (unique to each user), you could write:<table cellspacing="0" class="schemeblock"><tr><td>  (define-session-page (foo-page req sesh)</td></tr><tr><td>    (let ((c (session-get-val sesh 'counter 0)))</td></tr><tr><td>      (session-put-val! sesh 'counter (+ 1 c))</td></tr><tr><td>      (number->string c)))</td></tr></table>When you define a session page, the session is automatically fetched for you (and created if necessary), and bound to the session identifier you provided.<h5>3.2.2<tt> </tt><a name="(part._.Accessing_sessions)"></a>Accessing sessions</h5><table cellspacing="0" class="boxed"><tr><td>(session-get-val session key [missing-val]) → any</td></tr><tr><td>  session : session</td></tr><tr><td>  key : symbol</td></tr><tr><td>  missing-val : any = #f</td></tr></table><table cellspacing="0" class="boxed"><tr><td>(session-put-val! session key val) → session</td></tr><tr><td>  session : session</td></tr><tr><td>  key : symbol</td></tr><tr><td>  val : any</td></tr></table><h4>3.3<tt> </tt><a name="(part._.Users)"></a>Users</h4>LeftParen provides built-in functionality for dealing with users, including registering users, logging users in and out, and storing persistent data about users. To get up-and-running quickly, you can use the high-level welcome-message function:<table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(welcome-message</td><td> </td><td>session</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> [</td><td>#:on-success success-fn</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> </td><td>#:no-register no-register])</td><td> </td><td>→</td><td> </td><td>xexpr</td></tr></table></td></tr><tr><td>  session : session?</td></tr><tr><td>  success-fn : (or/c (-> user? xexpr?) #f) = #f</td></tr><tr><td>  no-register : boolean? = #f</td></tr></table>The function welcome-message produces a small area of text and links (commonly found in the top-right area of a web app). If the user is not currently logged in, login and register links are presented. If the user is logged in, a message welcoming them is displayed, along with a link to log out.<table cellspacing="0" class="boxed"><tr><td>(current-user session) → (or/c user? #f)</td></tr><tr><td>  session : session?</td></tr></table>The function current-user returns the current user record, or #f if no user is available in the current session.As an example, here is the complete page code for a web app that allows users to register, login and logout, and which prints a secret message if the user is logged in:<table cellspacing="0" class="schemeblock"><tr><td>  (define-session-page (index-page req sesh)</td></tr><tr><td>    (** (welcome-message sesh)</td></tr><tr><td>        (aif (current-user sesh)</td></tr><tr><td>             (format "The secret, ~A, is 42." (rec-prop it 'username))</td></tr><tr><td>             "No secret for you.")))</td></tr></table><h4>3.4<tt> </tt><a name="(part._.Feeds)"></a>Feeds</h4>You can create Atom or RSS feeds in your web app. A feed in LeftParen is just a page crafted in a paricular way. The core functions involved are atom-feed and rss-feed:<table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(atom-feed</td><td> </td><td>atom-feed-page</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-title feed-title</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-updated/epoch-seconds updated-seconds</td><td> </td></tr><tr><td> </td><td> </td><td>#:author-name author-name</td><td> </td></tr><tr><td> </td><td> [</td><td>#:feed-description feed-description</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-id feed-id</td><td> </td></tr><tr><td> </td><td> </td><td>#:related-content-link related-content-link</td><td> </td></tr><tr><td> </td><td> </td><td>#:items atom-items])</td><td> </td></tr></table></td></tr><tr><td> → response/full?</td></tr><tr><td>  atom-feed-page : page?</td></tr><tr><td>  feed-title : string?</td></tr><tr><td>  updated-seconds : integer?</td></tr><tr><td>  author-name : string?</td></tr><tr><td>  feed-description : (or/c #f string?) = #f</td></tr><tr><td>  feed-id : string? = THE_URL_OF_THE_GIVEN_ATOM_FEED_PAGE</td></tr><tr><td>  related-content-link : string? = THE_LINK_TO_YOUR_WEB_APP</td></tr><tr><td>  atom-items : (list-of atom-item?) = '()</td></tr></table><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(rss-feed</td><td> </td><td>rss-feed-page</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-title feed-title</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-description feed-description</td><td> </td></tr><tr><td> </td><td> [</td><td>#:related-content-link related-content-link</td><td> </td></tr><tr><td> </td><td> </td><td>#:items rss-items])</td><td> </td></tr></table></td></tr><tr><td> → response/full?</td></tr><tr><td>  rss-feed-page : page?</td></tr><tr><td>  feed-title : string?</td></tr><tr><td>  feed-description : string?</td></tr><tr><td>  related-content-link : string? = THE_LINK_TO_YOUR_WEB_APP</td></tr><tr><td>  rss-items : (list-of rss-item?) = '()</td></tr></table>The #:items argument in each of these functions is a list of items constructed with atom-item and rss-item:<table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(atom-item</td><td> </td><td>#:title title</td><td> </td></tr><tr><td> </td><td> </td><td>#:url url</td><td> </td></tr><tr><td> </td><td> </td><td>#:updated-epoch-seconds updated-seconds</td><td> </td></tr><tr><td> </td><td> [</td><td>#:content content])</td><td> </td></tr></table></td></tr><tr><td> → atom-item?</td></tr><tr><td>  title : string?</td></tr><tr><td>  url : string?</td></tr><tr><td>  updated-seconds : integer?</td></tr><tr><td>  content : (or/c #f string?) = #f</td></tr></table><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(rss-item</td><td> </td><td>#:title title</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> </td><td>#:url url</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> [</td><td>#:content content])</td><td> </td><td>→</td><td> </td><td>rss-item?</td></tr></table></td></tr><tr><td>  title : string?</td></tr><tr><td>  url : string?</td></tr><tr><td>  content : (or/c #f string?) = #f</td></tr></table>Here’s an example Atom feed page:<table cellspacing="0" class="schemeblock"><tr><td>  (define-page (article-feed-page req)</td></tr><tr><td>    #:blank #t</td></tr><tr><td>    (atom-feed article-feed-page</td></tr><tr><td>               #:feed-title "LeftParen blog"</td></tr><tr><td>               #:feed-description "On LeftParen..."</td></tr><tr><td>               #:feed-updated/epoch-seconds (current-seconds)</td></tr><tr><td>               #:author-name "LP staffers"</td></tr><tr><td>               #:items (list</td></tr><tr><td>                        (atom-item #:title "Status update..."</td></tr><tr><td>                                   #:url "http://blog.../50308696"</td></tr><tr><td>                                   #:updated-epoch-seconds</td></tr><tr><td>                                   (current-seconds)</td></tr><tr><td>                                   #:content "I’m nearing a...")</td></tr><tr><td>                        (atom-item #:title "LeftParen 0.3..."</td></tr><tr><td>                                   #:updated-epoch-seconds</td></tr><tr><td>                                   (current-seconds)</td></tr><tr><td>                                   #:url "http://blog.../51814971"</td></tr><tr><td>                                   #:content "Tonight I..."))))</td></tr></table>Note that while using current-seconds for timestamps does satisfy the interface, it’s not really appropriate since these times are supposed to indicated freshness of the data. If basing your feed off of records, you might consider using created-when.<h3>4<tt> </tt><a name="(part._.About_.Acknowledgements)"></a>About/Acknowledgements</h3>LeftParen was written by <a href="http://robhunter.org">Rob Hunter</a>, but it builds heavily on (and, in fact, often directly incorporates) the work of <a href="http://untyped.com/">Untyped</a> (<a href="http://planet.plt-scheme.org/display.ss?package=instaservlet.plt&owner=untyped">instaservlet</a> and <a href="http://planet.plt-scheme.org/display.ss?package=dispatch.plt&owner=untyped">dispatch</a>), <a href="http://scheme.dk/blog/">Jens Axel Soegaard</a> (<a href="http://planet.plt-scheme.org/display.ss?package=web.plt&owner=soegaard">web.plt</a>), and of course, <a href="http://www.plt-scheme.org/">PLT Scheme</a>.<h4>4.1<tt> </tt><a name="(part._.Contributors)"></a>Contributors</h4><ul><li>Bill Hager</li><li>Joshua Herman</li></ul><div class="navset" style="margin-top: 2em; border-top: 2px solid #e0e0c0;"><input style="width: 16em; margin: 0px; padding: 0px; background-color: #eee; color: #888; border: 1px solid #ddd; text-align: center; vertical-align: middle;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "4.1.0.3", "");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }" />   </div></div></div></body></html> \ No newline at end of file +<html><head><meta http-equiv="content-type" content="text-html; charset=utf-8" /><title>LeftParen 0.5 Documentation</title><link rel="stylesheet" type="text/css" href="scribble.css" title="default" /><script type="text/javascript" src="scribble-common.js"></script></head><body><div class="tocset"><div class="tocview"><div class="tocviewlist" style="margin-bottom: 1em;"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><a href="file:///Users/rob/Documents/leftparen/scribblings/leftparen.html" class="tocviewselflink">Left Paren 0.5 Documentation</a></td></tr></table></div><div class="tocviewsublistonly" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="file:///Users/rob/Documents/leftparen/scribblings/leftparen.html#(part._.Installing_.Left.Paren)" class="tocviewlink">Installing Left Paren</a></td></tr><tr><td align="right">2 </td><td><a href="file:///Users/rob/Documents/leftparen/scribblings/leftparen.html#(part._tutorials)" class="tocviewlink">Tutorials</a></td></tr><tr><td align="right">3 </td><td><a href="file:///Users/rob/Documents/leftparen/scribblings/leftparen.html#(part._.Reference)" class="tocviewlink">Reference</a></td></tr><tr><td align="right">4 </td><td><a href="file:///Users/rob/Documents/leftparen/scribblings/leftparen.html#(part._.About_.Acknowledgements)" class="tocviewlink">About/ Acknowledgements</a></td></tr></table></div></div></div><div class="tocsub"><table class="tocsublist" cellspacing="0"><tr><td>1<tt> </tt><a href="#(part._.Installing_.Left.Paren)" class="tocsubseclink">Installing Left Paren</a></td></tr><tr><td>2<tt> </tt><a href="#(part._tutorials)" class="tocsubseclink">Tutorials</a></td></tr><tr><td>2.1<tt> </tt><a href="#(part._.Hello__.World)" class="tocsubseclink">Hello, World</a></td></tr><tr><td>2.2<tt> </tt><a href="#(part._.Blogerton_the_.Blog)" class="tocsubseclink">Blogerton the Blog</a></td></tr><tr><td>2.2.1<tt> </tt><a href="#(part._.Changes_to_app_scm)" class="tocsubseclink">Changes to app.scm</a></td></tr><tr><td>2.2.2<tt> </tt><a href="#(part._.Changes_to_main_scm)" class="tocsubseclink">Changes to main.scm</a></td></tr><tr><td>2.2.3<tt> </tt><a href="#(part._.Launch_.Blogerton)" class="tocsubseclink">Launch Blogerton</a></td></tr><tr><td>3<tt> </tt><a href="#(part._.Reference)" class="tocsubseclink">Reference</a></td></tr><tr><td>3.1<tt> </tt><a href="#(part._.Forms)" class="tocsubseclink">Forms</a></td></tr><tr><td>3.1.1<tt> </tt><a href="#(part._.Image_uploads)" class="tocsubseclink">Image uploads</a></td></tr><tr><td>3.2<tt> </tt><a href="#(part._.Sessions)" class="tocsubseclink">Sessions</a></td></tr><tr><td>3.2.1<tt> </tt><a href="#(part._.Creating_sessions)" class="tocsubseclink">Creating sessions</a></td></tr><tr><td>3.2.2<tt> </tt><a href="#(part._.Accessing_sessions)" class="tocsubseclink">Accessing sessions</a></td></tr><tr><td>3.3<tt> </tt><a href="#(part._.Users)" class="tocsubseclink">Users</a></td></tr><tr><td>3.4<tt> </tt><a href="#(part._.Feeds)" class="tocsubseclink">Feeds</a></td></tr><tr><td>4<tt> </tt><a href="#(part._.About_.Acknowledgements)" class="tocsubseclink">About/ Acknowledgements</a></td></tr><tr><td>4.1<tt> </tt><a href="#(part._.Code_.Contributors)" class="tocsubseclink">Code Contributors</a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="versionbox">Version: 4.1.3.9</div><h2><a name="(part._.Left.Paren_0_5_.Documentation)"></a>LeftParen 0.5 Documentation</h2>Website: <a href="http://leftparen.com">http://leftparen.com</a>LeftParen is a framework for quickly creating web apps. It runs on +PLT Scheme v4.1.3 or greater. LeftParen is released under an <a href="http://github.com/vegashacker/leftparen/tree/master/MIT-LICENSE.txt">MIT License</a>. The source is available on <a href="http://github.com/vegashacker/leftparen/tree/master">github</a>.<h3>1<tt> </tt><a name="(part._.Installing_.Left.Paren)"></a>Installing LeftParen</h3>You’ll need PLT Scheme v4.1.3 or greater installed.Make sure that mzscheme is in your path. You should be ready +to go if you can do this:<table cellspacing="0"><tr><td>% mzscheme</td></tr><tr><td>Welcome to MzScheme v4.1.3...</td></tr><tr><td>></td></tr></table>Installing LeftParen is done behind the scenes with a <a href="http://planet.plt-scheme.org/">PLaneT</a> require. See <a href="file:///Users/rob/Documents/leftparen/scribblings/leftparen.html#(part._tutorials)">Tutorials</a> for examples of this. When you +first issue one of these require commands, you’ll automatically download the LeftParen files to your local PLaneT cache. This can sometimes take a few moments, so be prepared to wait a bit.<h3>2<tt> </tt><a name="(part._tutorials)"></a>Tutorials</h3><h4>2.1<tt> </tt><a name="(part._.Hello__.World)"></a>Hello, World</h4>We’re going to make a project called hello-world. Change to the directory that you’d like to make the project in. Then issue<table cellspacing="0"><tr><td>% mzscheme -e '(require (planet vegashacker/leftparen:4:0/generate))' hello-world</td></tr></table>This will create a hello-world project directory for you. In this directory you’ll find the script directory, which contains some useful scripts. All paths are relative to this project directory, so when calling scripts, you always want to be at the project root.<table cellspacing="0"><tr><td>% cd hello-world</td></tr></table>We need to make the scripts executable:<table cellspacing="0"><tr><td>% chmod u+x script/server</td></tr></table>LeftParen has automatically generated everything we need to run our web app – we just need to start the server (again, you should be at the project root directory):<table cellspacing="0"><tr><td>% ./script/server</td></tr><tr><td>Web server started on port 8765</td></tr><tr><td>Listening on IP address: 127.0.0.1</td></tr><tr><td>Type stop to stop the server and exit</td></tr><tr><td>Type restart to restart the server</td></tr></table>Point your browser to <a href="http://localhost:8765">http://localhost:8765</a> and you should see a familiar greeting:Hello, World!<h4>2.2<tt> </tt><a name="(part._.Blogerton_the_.Blog)"></a>Blogerton the Blog</h4>Now let’s try implementing the true "hello world" of web apps – a blog. First, execute the following commands from the directory in which you want to create your project directory:<table cellspacing="0"><tr><td>% mzscheme -e '(require (planet vegashacker/leftparen:4:0/generate))' blogerton</td></tr><tr><td>% cd blogerton</td></tr><tr><td>% chmod u+x script/server</td></tr></table><h5>2.2.1<tt> </tt><a name="(part._.Changes_to_app_scm)"></a>Changes to app.scm</h5>We need to register a couple of pages in our app. The index-page was already set up for you, but you’ll need to add a page to create new posts, and one to view them. Make the define-app call look like this:<table cellspacing="0" class="schemeblock"><tr><td>  (define-app my-app</td></tr><tr><td>    (index-page (url "/"))</td></tr><tr><td>    (create-post-page (url "/post"))</td></tr><tr><td>    (view-post-page (url "/view/" (string-arg))))</td></tr></table><h5>2.2.2<tt> </tt><a name="(part._.Changes_to_main_scm)"></a>Changes to main.scm</h5>Now we need to define those pages that we declared in app.scm.<table cellspacing="0" class="schemeblock"><tr><td>  (define-page (index-page req)</td></tr><tr><td>    (** `(h1 "Blogerton")</td></tr><tr><td>        `(p ,(web-link "Create a new post" (page-url create-post-page)))</td></tr><tr><td>        `(ul ,@(map (lambda (p) `(li ,(paint-blog-post p)))</td></tr><tr><td>                    (load-where '((type . blog-post))</td></tr><tr><td>                                #:sort-by 'created-at #:compare >)))))</td></tr><tr><td>  </td></tr><tr><td>  (define-page (create-post-page req)</td></tr><tr><td>    (form '((title "Title" text) (body "Body" long-text))</td></tr><tr><td>          #:init '((type . blog-post))</td></tr><tr><td>          #:on-done (lambda (post) (redirect-to-page view-post-page (rec-id post)))))</td></tr><tr><td>  </td></tr><tr><td>  (define-page (view-post-page req post-id)</td></tr><tr><td>    (paint-blog-post (load-rec post-id #:ensure '((type . blog-post)))))</td></tr><tr><td>  </td></tr><tr><td>  (define (paint-blog-post post)</td></tr><tr><td>    `(div (h2 ,(rec-prop post 'title))</td></tr><tr><td>          (p ,(rec-prop post 'body))))</td></tr></table><h5>2.2.3<tt> </tt><a name="(part._.Launch_.Blogerton)"></a>Launch Blogerton</h5>You’re ready for launch. Start the server with<table cellspacing="0"><tr><td>% ./script/server</td></tr></table>and you should have a basic blogging app, with persistent data, in 19 lines of code.<h3>3<tt> </tt><a name="(part._.Reference)"></a>Reference</h3><h4>3.1<tt> </tt><a name="(part._.Forms)"></a>Forms</h4>Most web applications make some use of web forms. The form function lets easily you get and process input from your users.<table cellspacing="0" class="boxed"><tr><td>(form field-specs) → xexpr?</td></tr><tr><td>  field-specs : (listof field-spec?)</td></tr></table><table cellspacing="0" class="boxed"><tr><td>field-spec? : (list symbol? string? field-type?)</td></tr></table><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="argcontract"><tr><td>field-type? : </td><td><table cellspacing="0" class="schemeblock"><tr><td>(or/c 'text 'long-text 'number 'password 'image 'checkbox</td></tr><tr><td>      'radio 'drop-down)</td></tr></table></td></tr></table></td></tr></table>You create a form by listing, in order, "field specifications". For example, you might want a title field, followed by a description text box, followed by a photo upload field. Note that the many keyword arguments available to the form function aren’t documented yet.Each field spec is of the form (field-name label field-type). For example, you create a title field, you might use the spec (title "Enter a title" text). The entire example metioned above might look like this:<table cellspacing="0" class="schemeblock"><tr><td>  (form '((title "Title" text)</td></tr><tr><td>          (description "Description" long-text)</td></tr><tr><td>          (photo "Your photo" image)))</td></tr></table><h5>3.1.1<tt> </tt><a name="(part._.Image_uploads)"></a>Image uploads</h5>By default, uploaded images are stored in the uploaded-files directory in your project directory. You can customize this with the *PATH_TO_UPLOADED_FILES* setting. When images are saved, their original filenames are used with a 5-character code pre-pended to make filenames unique.<h4>3.2<tt> </tt><a name="(part._.Sessions)"></a>Sessions</h4>A session is an object that allows you to easily store state about individual visitors to your web app. Sessions are stored on the server as a record with a virtually impossible-to-guess id. A cookie is left in the user’s web browser, which contains a pointer to a particular session id. These cookies expire one month after creation and, currently, this can’t be changed.<h5>3.2.1<tt> </tt><a name="(part._.Creating_sessions)"></a>Creating sessions</h5><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="schemeblock"><tr><td>(define-session-page</td></tr><tr><td>  (page-name request-iden session-iden page-args ...)</td></tr><tr><td>  body ...)</td></tr></table></td></tr></table>This is an alternate to define-page, most commonly used in main.scm. The only difference is that after the request identifier, you must provide a session identifier. For example, to keep a counter (unique to each user), you could write:<table cellspacing="0" class="schemeblock"><tr><td>  (define-session-page (foo-page req sesh)</td></tr><tr><td>    (let ((c (session-get-val sesh 'counter 0)))</td></tr><tr><td>      (session-put-val! sesh 'counter (+ 1 c))</td></tr><tr><td>      (number->string c)))</td></tr></table>When you define a session page, the session is automatically fetched for you (and created if necessary), and bound to the session identifier you provided.<h5>3.2.2<tt> </tt><a name="(part._.Accessing_sessions)"></a>Accessing sessions</h5><table cellspacing="0" class="boxed"><tr><td>(session-get-val session key [missing-val]) → any</td></tr><tr><td>  session : session</td></tr><tr><td>  key : symbol</td></tr><tr><td>  missing-val : any = #f</td></tr></table><table cellspacing="0" class="boxed"><tr><td>(session-put-val! session key val) → session</td></tr><tr><td>  session : session</td></tr><tr><td>  key : symbol</td></tr><tr><td>  val : any</td></tr></table><h4>3.3<tt> </tt><a name="(part._.Users)"></a>Users</h4>LeftParen provides built-in functionality for dealing with users, including registering users, logging users in and out, and storing persistent data about users. To get up-and-running quickly, you can use the high-level welcome-message function:<table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(welcome-message</td><td> </td><td>session</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> [</td><td>#:on-success success-fn</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> </td><td>#:no-register no-register])</td><td> </td><td>→</td><td> </td><td>xexpr</td></tr></table></td></tr><tr><td>  session : session?</td></tr><tr><td>  success-fn : (or/c (-> user? xexpr?) #f) = #f</td></tr><tr><td>  no-register : boolean? = #f</td></tr></table>The function welcome-message produces a small area of text and links (commonly found in the top-right area of a web app). If the user is not currently logged in, login and register links are presented. If the user is logged in, a message welcoming them is displayed, along with a link to log out.<table cellspacing="0" class="boxed"><tr><td>(current-user session) → (or/c user? #f)</td></tr><tr><td>  session : session?</td></tr></table>The function current-user returns the current user record, or #f if no user is available in the current session.As an example, here is the complete page code for a web app that allows users to register, login and logout, and which prints a secret message if the user is logged in:<table cellspacing="0" class="schemeblock"><tr><td>  (define-session-page (index-page req sesh)</td></tr><tr><td>    (** (welcome-message sesh)</td></tr><tr><td>        (aif (current-user sesh)</td></tr><tr><td>             (format "The secret, ~A, is 42." (rec-prop it 'username))</td></tr><tr><td>             "No secret for you.")))</td></tr></table><h4>3.4<tt> </tt><a name="(part._.Feeds)"></a>Feeds</h4>You can create Atom or RSS feeds in your web app. A feed in LeftParen is just a page crafted in a paricular way. The core functions involved are atom-feed and rss-feed:<table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(atom-feed</td><td> </td><td>atom-feed-page</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-title feed-title</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-updated/epoch-seconds updated-seconds</td><td> </td></tr><tr><td> </td><td> </td><td>#:author-name author-name</td><td> </td></tr><tr><td> </td><td> [</td><td>#:feed-description feed-description</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-id feed-id</td><td> </td></tr><tr><td> </td><td> </td><td>#:related-content-link related-content-link</td><td> </td></tr><tr><td> </td><td> </td><td>#:items atom-items])</td><td> </td></tr></table></td></tr><tr><td> → response/full?</td></tr><tr><td>  atom-feed-page : page?</td></tr><tr><td>  feed-title : string?</td></tr><tr><td>  updated-seconds : integer?</td></tr><tr><td>  author-name : string?</td></tr><tr><td>  feed-description : (or/c #f string?) = #f</td></tr><tr><td>  feed-id : string? = THE_URL_OF_THE_GIVEN_ATOM_FEED_PAGE</td></tr><tr><td>  related-content-link : string? = THE_LINK_TO_YOUR_WEB_APP</td></tr><tr><td>  atom-items : (list-of atom-item?) = '()</td></tr></table><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(rss-feed</td><td> </td><td>rss-feed-page</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-title feed-title</td><td> </td></tr><tr><td> </td><td> </td><td>#:feed-description feed-description</td><td> </td></tr><tr><td> </td><td> [</td><td>#:related-content-link related-content-link</td><td> </td></tr><tr><td> </td><td> </td><td>#:items rss-items])</td><td> </td></tr></table></td></tr><tr><td> → response/full?</td></tr><tr><td>  rss-feed-page : page?</td></tr><tr><td>  feed-title : string?</td></tr><tr><td>  feed-description : string?</td></tr><tr><td>  related-content-link : string? = THE_LINK_TO_YOUR_WEB_APP</td></tr><tr><td>  rss-items : (list-of rss-item?) = '()</td></tr></table>The #:items argument in each of these functions is a list of items constructed with atom-item and rss-item:<table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(atom-item</td><td> </td><td>#:title title</td><td> </td></tr><tr><td> </td><td> </td><td>#:url url</td><td> </td></tr><tr><td> </td><td> </td><td>#:updated-epoch-seconds updated-seconds</td><td> </td></tr><tr><td> </td><td> [</td><td>#:content content])</td><td> </td></tr></table></td></tr><tr><td> → atom-item?</td></tr><tr><td>  title : string?</td></tr><tr><td>  url : string?</td></tr><tr><td>  updated-seconds : integer?</td></tr><tr><td>  content : (or/c #f string?) = #f</td></tr></table><table cellspacing="0" class="boxed"><tr><td><table cellspacing="0" class="prototype"><tr><td>(rss-item</td><td> </td><td>#:title title</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> </td><td>#:url url</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td> </td><td> [</td><td>#:content content])</td><td> </td><td>→</td><td> </td><td>rss-item?</td></tr></table></td></tr><tr><td>  title : string?</td></tr><tr><td>  url : string?</td></tr><tr><td>  content : (or/c #f string?) = #f</td></tr></table>Here’s an example Atom feed page:<table cellspacing="0" class="schemeblock"><tr><td>  (define-page (article-feed-page req)</td></tr><tr><td>    #:blank #t</td></tr><tr><td>    (atom-feed article-feed-page</td></tr><tr><td>               #:feed-title "LeftParen blog"</td></tr><tr><td>               #:feed-description "On LeftParen..."</td></tr><tr><td>               #:feed-updated/epoch-seconds (current-seconds)</td></tr><tr><td>               #:author-name "LP staffers"</td></tr><tr><td>               #:items (list</td></tr><tr><td>                        (atom-item #:title "Status update..."</td></tr><tr><td>                                   #:url "http://blog.../50308696"</td></tr><tr><td>                                   #:updated-epoch-seconds</td></tr><tr><td>                                   (current-seconds)</td></tr><tr><td>                                   #:content "I’m nearing a...")</td></tr><tr><td>                        (atom-item #:title "LeftParen 0.3..."</td></tr><tr><td>                                   #:updated-epoch-seconds</td></tr><tr><td>                                   (current-seconds)</td></tr><tr><td>                                   #:url "http://blog.../51814971"</td></tr><tr><td>                                   #:content "Tonight I..."))))</td></tr></table>Note that while using current-seconds for timestamps does satisfy the interface, it’s not really appropriate since these times are supposed to indicated freshness of the data. If basing your feed off of records, you might consider using created-when.<h3>4<tt> </tt><a name="(part._.About_.Acknowledgements)"></a>About/Acknowledgements</h3>LeftParen was written by <a href="http://robhunter.org">Rob Hunter</a>, but it builds heavily on (and, in fact, often directly incorporates) the work of <a href="http://untyped.com/">Untyped</a> (<a href="http://planet.plt-scheme.org/display.ss?package=dispatch.plt&owner=untyped">dispatch</a>), <a href="http://scheme.dk/blog/">Jens Axel Soegaard</a> (<a href="http://planet.plt-scheme.org/display.ss?package=web.plt&owner=soegaard">web.plt</a>), and of course, <a href="http://www.plt-scheme.org/">PLT Scheme</a>.<h4>4.1<tt> </tt><a name="(part._.Code_.Contributors)"></a>Code Contributors</h4><ul><li>Bill Hager</li><li>Joshua Herman</li></ul></div></div></body></html> \ No newline at end of file scribblings/leftparen.html @@ -1,27 +1,27 @@ #lang scribble/doc @(require scribble/manual) -@title{LeftParen 0.4 Documentation} +@title{LeftParen 0.5 Documentation} Website: @link["http://leftparen.com"]{http://leftparen.com} LeftParen is a framework for quickly creating web apps. It runs on -PLT Scheme v4.1 or greater. LeftParen is released under an @link["http://github.com/vegashacker/leftparen/tree/master/MIT-LICENSE.txt"]{MIT License}. The source is available on @link["http://github.com/vegashacker/leftparen/tree/master"]{github}. +PLT Scheme v4.1.3 or greater. LeftParen is released under an @link["http://github.com/vegashacker/leftparen/tree/master/MIT-LICENSE.txt"]{MIT License}. The source is available on @link["http://github.com/vegashacker/leftparen/tree/master"]{github}. @section{Installing LeftParen} -You'll need PLT Scheme v4.1 or greater installed. +You'll need PLT Scheme v4.1.3 or greater installed. Make sure that @scheme[mzscheme] is in your path. You should be ready to go if you can do this: @verbatim{ % mzscheme -Welcome to MzScheme v4.1... +Welcome to MzScheme v4.1.3... > } -Installing LeftParen is done behind the scenes with a @link["http://planet.plt-scheme.org/"]{PLaneT} @scheme[require]. See @secref{tutorials} for an example of this. When you +Installing LeftParen is done behind the scenes with a @link["http://planet.plt-scheme.org/"]{PLaneT} @scheme[require]. See @secref{tutorials} for examples of this. When you first issue one of these @scheme[require] commands, you'll automatically download the LeftParen files to your local PLaneT cache. This can sometimes take a few moments, so be prepared to wait a bit. @section[#:tag "tutorials"]{Tutorials} @@ -30,7 +30,7 @@ first issue one of these @scheme[require] commands, you'll automatically downloa We're going to make a project called @tt{hello-world}. Change to the directory that you'd like to make the project in. Then issue -@verbatim{% mzscheme -e '(require (planet "bootstrap.scm" ("vegashacker" "leftparen.plt" 3 0)))' project hello-world} +@verbatim{% mzscheme -e '(require (planet vegashacker/leftparen:4:0/generate))' hello-world} This will create a @tt{hello-world} project directory for you. In this directory you'll find the @tt{script} directory, which contains some useful scripts. All paths are relative to this project directory, so when calling scripts, you always want to be at the project root. @@ -38,7 +38,7 @@ This will create a @tt{hello-world} project directory for you. In this director We need to make the scripts executable: -@verbatim{% chmod u+x script/*} +@verbatim{% chmod u+x script/server} LeftParen has automatically generated everything we need to run our web app---we just need to start the server (again, you should be at the project root directory): @@ -59,9 +59,9 @@ Point your browser to @link["http://localhost:8765"]{http://localhost:8765} and Now let's try implementing the true "hello world" of web apps---a blog. First, execute the following commands from the directory in which you want to create your project directory: @verbatim{ -% mzscheme -e '(require (planet "bootstrap.scm" ("vegashacker" "leftparen.plt" 3 0)))' project blogerton +% mzscheme -e '(require (planet vegashacker/leftparen:4:0/generate))' blogerton % cd blogerton -% chmod u+x script/* +% chmod u+x script/server } @subsubsection{Changes to @tt{app.scm}} @@ -241,9 +241,9 @@ Note that while using @scheme[current-seconds] for timestamps does satisfy the i @section{About/Acknowledgements} -LeftParen was written by @link["http://robhunter.org"]{Rob Hunter}, but it builds heavily on (and, in fact, often directly incorporates) the work of @link["http://untyped.com/"]{Untyped} (@link["http://planet.plt-scheme.org/display.ss?package=instaservlet.plt&owner=untyped"]{instaservlet} and @link["http://planet.plt-scheme.org/display.ss?package=dispatch.plt&owner=untyped"]{dispatch}), @link["http://scheme.dk/blog/"]{Jens Axel Soegaard} (@link["http://planet.plt-scheme.org/display.ss?package=web.plt&owner=soegaard"]{web.plt}), and of course, @link["http://www.plt-scheme.org/"]{PLT Scheme}. +LeftParen was written by @link["http://robhunter.org"]{Rob Hunter}, but it builds heavily on (and, in fact, often directly incorporates) the work of @link["http://untyped.com/"]{Untyped} (@link["http://planet.plt-scheme.org/display.ss?package=dispatch.plt&owner=untyped"]{dispatch}), @link["http://scheme.dk/blog/"]{Jens Axel Soegaard} (@link["http://planet.plt-scheme.org/display.ss?package=web.plt&owner=soegaard"]{web.plt}), and of course, @link["http://www.plt-scheme.org/"]{PLT Scheme}. -@subsection{Contributors} +@subsection{Code Contributors} @itemize[ @item{Bill Hager} scribblings/leftparen.scrbl @@ -27,11 +27,23 @@ /* ---------------------------------------- */ +h2 { /* per-page main title */ + margin-top: 0; +} + h3, h4, h5, h6, h7, h8 { margin-top: 1.75em; margin-bottom: 0.5em; } +/* Needed for browsers like Opera, and eventually for HTML 4 conformance. + This means that multiple paragraphs in a table element do not have a space + between them. */ +table p { + margin-top: 0; + margin-bottom: 0; +} + /* ---------------------------------------- */ /* Main */ @@ -58,11 +70,21 @@ table td { /* ---------------------------------------- */ /* Navigation */ -.navset { +.navsettop, .navsetbottom { background-color: #f0f0e0; padding: 0.25em 0 0.25em 0; } +.navsettop { + margin-bottom: 1.5em; + border-bottom: 2px solid #e0e0c0; +} + +.navsetbottom { + margin-top: 2em; + border-top: 2px solid #e0e0c0; +} + .navleft { margin-left: 1ex; position: relative; @@ -79,6 +101,22 @@ table td { color: #e0e0e0; } +.searchform { + display: inline; + margin: 0; + padding: 0; +} + +.searchbox { + width: 16em; + margin: 0px; + padding: 0px; + background-color: #eee; + border: 1px solid #ddd; + text-align: center; + vertical-align: middle; +} + /* ---------------------------------------- */ /* Version */ scribblings/scribble.css @@ -1,6 +1,6 @@ #lang scheme/base -(require (planet "web.scm" ("soegaard" "web.plt" 2 1)) +(require "web-export.ss" "web-support.scm" (file "util.scm") (file "time.scm") session.scm @@ -19,7 +19,6 @@ (for-syntax scheme/base) scheme/match (lib "pretty.ss") - (planet "web.scm" ("soegaard" "web.plt" 2 1)) ; XXX get rid of this dependency (lib "unit.ss") (only-in file/md5 md5) @@ -139,8 +138,6 @@ (all-from-out scheme/match) - xexpr->string ; XXX implement yourself! - splice-if asplice-if util.scm @@ -3,9 +3,12 @@ ;; form validation (require "util.scm" - "record.scm") + "record.scm" + "contract-lp.ss") -(provide validate field-validate) +(provide validate + ;; field-validate (via contract) + ) ;; constructs a fn suitable for passing in to the #:validate keyword of a form call ;; the fn : rec -> content @@ -20,13 +23,24 @@ #f (string-join errors "\n"))))) -(define (field-validate field-name (pred #f)) +;; +;; field-validate +;; +(provide/contract (field-validate (->* (symbol?) + ((or/c #f (-> any/c any/c)) + #:msg-fn (-> any/c string?)) + (-> rec? (or/c #f string?))))) +;; +(define (field-validate field-name + (pred #f) + #:msg-fn (msg-fn (lambda (bad-val) + (format "'~A' is an invalid value for field ~A." + field-name bad-val)))) (lambda (rec) (aif (rec-prop rec field-name) (if pred (if (pred it) #f - (format "Validation error triggered by failure of ~A on field '~A'." - pred field-name)) + (msg-fn it)) #f) (format "Missing field '~A'." field-name)))) validate.scm @@ -1,11 +1,14 @@ #lang scheme/base +;; This differs from web-export.ss in that these are ones that we wrote and aren't +;; included in PLT libs. + (require (file "util.scm") - (lib "xml.ss" "xml") + xml net/url scheme/serialize + "web-export.ss" "contract-lp.ss" - (planet "web.scm" ("soegaard" "web.plt" 2 (= 1))) ) (provide request-all-bindings @@ -17,7 +20,6 @@ web-link img raw-str - with-binding ; from web.plt basic-response xexpr-if url+query web-support.scm bootstrap.scm 7070c10f9c63b8cf935a03271b6c1738347a678c Rob Hunter rob.hunter@gmail.com http://github.com/vegashacker/leftparen/commit/af0a54969668fece9b52269c99279e976b4ed04a af0a54969668fece9b52269c99279e976b4ed04a

2009-01-08T13:42:37-08:00

added web-export for convenient internal access to plt web-related tools; got rid of dependence on web.plt and uuid-v4.plt planet libraries; simplified project generation interface; upgraded LP to work with PLT's serve/servlet functionality; exported some facebook routines even though it's not ready for prime time; updated the documentation 45c96bb3688d7891d54a97f9a5239ea7712f6f01 Rob Hunter rob.hunter@gmail.com