forked from cadence/breezewiki
		
	Explain how page-search works in the code
This commit is contained in:
		
							parent
							
								
									a9754463b6
								
							
						
					
					
						commit
						4b039cca5e
					
				
					 1 changed files with 26 additions and 9 deletions
				
			
		| 
						 | 
					@ -28,28 +28,35 @@
 | 
				
			||||||
  (define search-json-data
 | 
					  (define search-json-data
 | 
				
			||||||
    '#hasheq((batchcomplete . #t) (query . #hasheq((search . (#hasheq((ns . 0) (pageid . 219) (size . 1482) (snippet . "") (timestamp . "2022-08-21T08:54:23Z") (title . "Gacha Capsule") (wordcount . 214)) #hasheq((ns . 0) (pageid . 201) (size . 1198) (snippet . "") (timestamp . "2022-07-11T17:52:47Z") (title . "Badges") (wordcount . 181)))))))))
 | 
					    '#hasheq((batchcomplete . #t) (query . #hasheq((search . (#hasheq((ns . 0) (pageid . 219) (size . 1482) (snippet . "") (timestamp . "2022-08-21T08:54:23Z") (title . "Gacha Capsule") (wordcount . 214)) #hasheq((ns . 0) (pageid . 201) (size . 1198) (snippet . "") (timestamp . "2022-07-11T17:52:47Z") (title . "Badges") (wordcount . 181)))))))))
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					;; this takes the info we gathered from fandom and makes the big fat x-expression page
 | 
				
			||||||
(define (generate-results-page req dest-url wikiname query data #:siteinfo [siteinfo #f])
 | 
					(define (generate-results-page req dest-url wikiname query data #:siteinfo [siteinfo #f])
 | 
				
			||||||
  (define search-results (jp "/query/search" data))
 | 
					  (define search-results (jp "/query/search" data))
 | 
				
			||||||
 | 
					  ;; this is *another* helper that builds the wiki page UI and lets me put the search results (or whatever else) in the middle
 | 
				
			||||||
  (generate-wiki-page
 | 
					  (generate-wiki-page
 | 
				
			||||||
 | 
					   ;; so I provide my helper function with the necessary context...
 | 
				
			||||||
   #:req req
 | 
					   #:req req
 | 
				
			||||||
   #:source-url dest-url
 | 
					   #:source-url dest-url
 | 
				
			||||||
   #:wikiname wikiname
 | 
					   #:wikiname wikiname
 | 
				
			||||||
   #:title query
 | 
					   #:title query
 | 
				
			||||||
   #:siteinfo siteinfo
 | 
					   #:siteinfo siteinfo
 | 
				
			||||||
 | 
					   ;; and here's the actual results to display in the wiki page layout
 | 
				
			||||||
   `(div (@ (class "mw-parser-output"))
 | 
					   `(div (@ (class "mw-parser-output"))
 | 
				
			||||||
 | 
					         ;; header before the search results showing how many we found
 | 
				
			||||||
         (p ,(format "~a results found for " (length search-results))
 | 
					         (p ,(format "~a results found for " (length search-results))
 | 
				
			||||||
            (strong ,query))
 | 
					            (strong ,query))
 | 
				
			||||||
 | 
					         ;; *u*nordered *l*ist of matching search results
 | 
				
			||||||
         (ul ,@(map
 | 
					         (ul ,@(map
 | 
				
			||||||
                (λ (result)
 | 
					                (λ (result) ;; for each result, run this code...
 | 
				
			||||||
                  (let* ([title (jp "/title" result)]
 | 
					                  (let* ([title (jp "/title" result)]
 | 
				
			||||||
                         [page-path (page-title->path title)]
 | 
					                         [page-path (page-title->path title)]
 | 
				
			||||||
                         [timestamp (jp "/timestamp" result)]
 | 
					                         [timestamp (jp "/timestamp" result)]
 | 
				
			||||||
                         [wordcount (jp "/wordcount" result)]
 | 
					                         [wordcount (jp "/wordcount" result)]
 | 
				
			||||||
                         [size (jp "/size" result)])
 | 
					                         [size (jp "/size" result)])
 | 
				
			||||||
 | 
					                    ;; and make this x-expression...
 | 
				
			||||||
                    `(li (@ (class "my-result"))
 | 
					                    `(li (@ (class "my-result"))
 | 
				
			||||||
                         (a (@ (class "my-result__link") (href ,(format "/~a/wiki/~a" wikiname page-path)))
 | 
					                         (a (@ (class "my-result__link") (href ,(format "/~a/wiki/~a" wikiname page-path))) ; using unquote to insert the result page URL
 | 
				
			||||||
                            ,title)
 | 
					                            ,title) ; using unquote to insert the result page title
 | 
				
			||||||
                         (div (@ (class "my-result__info"))
 | 
					                         (div (@ (class "my-result__info")) ; constructing the line under the search result
 | 
				
			||||||
                              "last edited "
 | 
					                              "last edited "
 | 
				
			||||||
                              (time (@ (datetime ,timestamp)) ,(list-ref (string-split timestamp "T") 0))
 | 
					                              (time (@ (datetime ,timestamp)) ,(list-ref (string-split timestamp "T") 0))
 | 
				
			||||||
                              ,(format ", ~a words, ~a kb"
 | 
					                              ,(format ", ~a words, ~a kb"
 | 
				
			||||||
| 
						 | 
					@ -57,13 +64,18 @@
 | 
				
			||||||
                                       (exact->inexact (/ (round (/ size 100)) 10)))))))
 | 
					                                       (exact->inexact (/ (round (/ size 100)) 10)))))))
 | 
				
			||||||
                search-results)))))
 | 
					                search-results)))))
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					;; will be called when the web browser asks to load the page
 | 
				
			||||||
(define (page-search req)
 | 
					(define (page-search req)
 | 
				
			||||||
 | 
					  ;; this just means, catch any errors and display them in the browser. it's a function somewhere else
 | 
				
			||||||
  (response-handler
 | 
					  (response-handler
 | 
				
			||||||
 | 
					   ;; the URL will look like "/minecraft/wiki/Special:Search?q=Spawner"
 | 
				
			||||||
 | 
					   ;; grab the first part to use as the wikiname, in this case, "minecraft"
 | 
				
			||||||
   (define wikiname (path/param-path (first (url-path (request-uri req)))))
 | 
					   (define wikiname (path/param-path (first (url-path (request-uri req)))))
 | 
				
			||||||
 | 
					   ;; grab the part after ?q= which is the search terms
 | 
				
			||||||
   (define query (dict-ref (url-query (request-uri req)) 'q #f))
 | 
					   (define query (dict-ref (url-query (request-uri req)) 'q #f))
 | 
				
			||||||
 | 
					   ;; constructing the URL where I want to get fandom data from...
 | 
				
			||||||
   (define origin (format "https://~a.fandom.com" wikiname))
 | 
					   (define origin (format "https://~a.fandom.com" wikiname))
 | 
				
			||||||
   (when (config-true? 'feature_offline::only)
 | 
					   ;; the dest-URL will look something like https://minecraft.fandom.com/api.php?action=query&list=search&srsearch=Spawner&formatversion=2&format=json
 | 
				
			||||||
     (raise-user-error "Full search is currently not available on breezewiki.com - for now, please use the pop-up search suggestions or wait for me to fix it! Thanks <3"))
 | 
					 | 
				
			||||||
   (define dest-url
 | 
					   (define dest-url
 | 
				
			||||||
     (format "~a/api.php?~a"
 | 
					     (format "~a/api.php?~a"
 | 
				
			||||||
             origin
 | 
					             origin
 | 
				
			||||||
| 
						 | 
					@ -73,21 +85,26 @@
 | 
				
			||||||
                              ("formatversion" . "2")
 | 
					                              ("formatversion" . "2")
 | 
				
			||||||
                              ("format" . "json")))))
 | 
					                              ("format" . "json")))))
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   ;; simultaneously get the search results from the fandom API, as well as information about the wiki as a whole (its license, icon, name)
 | 
				
			||||||
   (define-values (dest-res siteinfo)
 | 
					   (define-values (dest-res siteinfo)
 | 
				
			||||||
     (thread-values
 | 
					     (thread-values
 | 
				
			||||||
      (λ ()
 | 
					      (λ ()
 | 
				
			||||||
        (log-outgoing dest-url)
 | 
					        (log-outgoing dest-url)
 | 
				
			||||||
        (easy:get dest-url #:timeouts timeouts))
 | 
					        (easy:get dest-url #:timeouts timeouts)) ;; HTTP request to dest-url for search results
 | 
				
			||||||
      (λ ()
 | 
					      (λ ()
 | 
				
			||||||
        (siteinfo-fetch wikiname))))
 | 
					        (siteinfo-fetch wikiname)))) ;; helper function in another file to get information about the wiki
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   ;; search results are a JSON string. parse JSON into racket data structures
 | 
				
			||||||
   (define data (easy:response-json dest-res))
 | 
					   (define data (easy:response-json dest-res))
 | 
				
			||||||
 | 
					   ;; calling my generate-results-page function with the information so far in order to get a big fat x-expression
 | 
				
			||||||
 | 
					   ;; big fat x-expression goes into the body variable
 | 
				
			||||||
   (define body (generate-results-page req dest-url wikiname query data #:siteinfo siteinfo))
 | 
					   (define body (generate-results-page req dest-url wikiname query data #:siteinfo siteinfo))
 | 
				
			||||||
 | 
					   ;; error checking
 | 
				
			||||||
   (when (config-true? 'debug)
 | 
					   (when (config-true? 'debug)
 | 
				
			||||||
     ; used for its side effects
 | 
					     ; used for its side effects
 | 
				
			||||||
     ; convert to string with error checking, error will be raised if xexp is invalid
 | 
					     ; convert to string with error checking, error will be raised if xexp is invalid
 | 
				
			||||||
     (xexp->html body))
 | 
					     (xexp->html body))
 | 
				
			||||||
 | 
					   ;; convert body to HTML and send to browser
 | 
				
			||||||
   (response/output
 | 
					   (response/output
 | 
				
			||||||
    #:code 200
 | 
					    #:code 200
 | 
				
			||||||
    #:headers (build-headers always-headers)
 | 
					    #:headers (build-headers always-headers)
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue