OSDN Git Service

Publish MinGW installation and maintenance guidelines.
[mingw/website.git] / site.js
1 /*
2  * site.js
3  *
4  * General purpose functions for manipulation of page content.
5  *
6  *
7  * $Id$
8  *
9  * Written by Keith Marshall <keith@users.osdn.me>
10  * Copyright (C) 2020, 2021, MinGW.OSDN Project
11  *
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice, this permission notice, and the following
21  * disclaimer shall be included in all copies or substantial portions of
22  * the Software.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
27  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF OR OTHER
30  * DEALINGS IN THE SOFTWARE.
31  *
32  */
33 function set_content( item, value )
34 { /* Replace the existing content, if any, of the HTML element with
35    * id attribute named "item", (if such an element exists), with new
36    * content as specified by "value".
37    */
38   var element = document.getElementById( item );
39   if( element ) element.innerHTML = value;
40   return element;
41 }
42
43 function set_page( title, text )
44 { /* Helper function, for use in overlay page scripts, to update
45    * the "title" and "subtitle" fields within the page header; note
46    * that "text" may, and should, use ASCII hyphen-minus where any
47    * hyphen is to be represented; these will be replaced by HTML
48    * non-breaking hyphen entities, on header field assignment.
49    */
50   if( title == "title" ) document.title = text;
51   set_content( "page-".concat( title ), text.replace( /-/g, "&#8209;" ));
52 }
53
54 function load_content( container, src )
55 { /* Set the content of the specified HTML "container" element, by
56    * injection of the entire contents of an external file which is
57    * fetched by http server request; (either an http, or an https,
58    * server connection is required; does not work for local files).
59    */
60   var request_handler = new XMLHttpRequest();
61   request_handler.onreadystatechange = function()
62   { if( this.readyState == this.DONE )
63       switch( this.status )
64       { case 200:
65           var element = set_content( container, this.responseText );
66           var idx; element = element.getElementsByTagName( "script" );
67           set_content( "e404-missing-page", document.URL );
68           for( idx = 0; idx < element.length; idx++ )
69           { var onload_action = Function( element[idx].innerHTML );
70             onload_action();
71           }
72           if( src.includes("#") )
73           { src = src.substring( src.indexOf("#") + 1, src.length );
74             element = document.getElementById( src );
75             if( element ) element.scrollIntoView();
76           }
77           break;
78         case 404:
79           load_content( container, "missing.html" );
80       }
81   }
82   request_handler.open( "GET", src, true );
83   request_handler.send();
84 }
85
86 function load_page( src )
87 { /* Load page content from the HTML fragment file, as determined
88    * from the specified "src" URL; if no alternative fragment name
89    * is specified, fall back to loading "about.html".
90    */
91   const ref = "?page=";
92   const div = "page-content";
93   set_content( div, null );
94   load_content( "header", "header.html" );
95   if( src.includes( ref ) )
96     src = src.substring( src.indexOf( ref ) + ref.length, src.length );
97   else src = "about.html";
98   load_content( div, src );
99 }
100
101 /* Web-Search Widget Helper Functions
102  * ----------------------------------
103  * Derived from the DuckDuckGo.com search widget implementation by
104  * Juri Wornowitski, as described at https://www.plainlight.com/ddg,
105  * these facilitate incorporation of multiple search widget variants,
106  * at multiple locations across the site.
107  *
108  */
109 function ddg_widget( ref )
110 { /* Acquire a reference to the "submit" button, within the search
111    * widget; the containing "form" element uses this to simulate a
112    * click event, if the form is submitted by pressing the "enter"
113    * key, when the "input" field has the focus.
114    */
115   ref = ref.getElementsByTagName( "button" );
116   for( idx = 0; idx < ref.length; idx++ )
117     if( ref[idx].type == "submit" ) return ref[idx];
118   return undefined;
119 }
120
121 function ddg_google_search_site( domain )
122 { /* Encode a search "domain" as a "site:" reference, to be appended
123    * to the query URL, when a DuckDuckGo.com search is directed to the
124    * Google search engine, via DuckDuckGo.com's "bang" facility.
125    */
126   return "+".concat( encodeURIComponent( "site:".concat( domain )));
127 }
128
129 function ddg_bang( src, query, domain )
130 { /* Set up a query, using DuckDuckGo.com's "bang" facility, (directed
131    * to the "bang" identified by "src"); append the query, appropriately
132    * encoded, and optionally a "domain" URL whence the query results are
133    * to be retrieved.
134    */
135   const bang = "https://duckduckgo.com?q=".concat( encodeURIComponent( "!" ));
136   query = bang.concat( src.concat( "+".concat( encodeURIComponent( query ))));
137   return query.concat( domain );
138 }
139
140 function ddg_query( widget )
141 { /* Retrieve the current value entered into the query "input" field;
142    * (this is identified by having a "name" property value of "q").
143    */
144   widget = widget.getElementsByTagName( "input" );
145   for( idx = 0; idx < widget.length; idx++ )
146     if( widget[idx].name == "q" ) return widget[idx].value;
147   return undefined;
148 }
149
150 function ddg_google_search( widget, target, domain )
151 { /* Initiate a Google search, from the DuckDuckGo.com search widget;
152    * (the "widget" reference is initially associated with the "submit"
153    * button, whence we retrieve the query context via the parent form).
154    * If "domain" is not null, it is assumed to represent a "site:" URL,
155    * where the search is to be performed, while boolean value "target"
156    * indicates whether or not a new browser window is to be opened to
157    * display the search results.
158    */
159   var query = ddg_query( widget.parentElement );
160   if( domain.length > 0 ) domain = ddg_google_search_site( domain );
161   if( target ) window.open( ddg_bang( "g", query, domain ));
162   else ddg_bang( "g", query, domain );
163   return false;
164 }
165
166 function osdn_archive( project, list )
167 { /* Construct a URL to represent the search domain for an OSDN.net
168    * mailing list archive, for any specified "list", belonging to a
169    * specified "project".
170    */
171   const template = "https://osdn.net/projects/%P%/lists/archive/";
172   return template.replace( "%P%", project ).concat( list );
173 }
174
175 /* $RCSfile$: end of file */