finish up the documentation page

Signed-off-by: ngn <ngn@ngn.tf>

api/database/metrics.go

@@ -44,7 +44,7 @@ func (db *Type) MetricsSet(key string, value uint64) error {
 		return err
 	} else if effected < 1 {
 		_, err = db.sql.Exec(
-			`INSERT INTO "+TABLE_METRICS+"(
+			"INSERT INTO "+TABLE_METRICS+`(
 			  key, value
 		  ) values(?, ?)`,
 			key, value,

api/routes/metrics.go

@@ -8,30 +8,25 @@ import (
 	"github.com/ngn13/website/api/util"
 )
 
-type visitor_cache_entry struct {
+const VISITOR_CACHE_MAX = 30 // store 30 visitor data at most
-	Addr   string // SHA1 hash of visitor's IP
+var visitor_cache []string   // in memory cache for the visitor addresses
-	Number uint64 // number of the visitor
-}
-
-const VISITOR_CACHE_MAX = 30            // store 30 visitor data at most
-var visitor_cache []visitor_cache_entry // in memory cache for the visitor
 
 func GET_Metrics(c *fiber.Ctx) error {
 	var (
 		err    error
 		result map[string]uint64 = map[string]uint64{
-			"number": 0, // visitor number of the current visitor
+			"total": 0, // total number of visitors
-			"total":  0, // total number of visitors
+			"since": 0, // metric collection start date (UNIX timestamp)
-			"since":  0, // metric collection start date (UNIX timestamp)
 		}
 	)
 
 	db := c.Locals("database").(*database.Type)
 	new_addr := util.GetSHA1(util.IP(c))
+	is_in_cache := false
 
-	for i := range visitor_cache {
+	for _, cache := range visitor_cache {
-		if new_addr == visitor_cache[i].Addr {
+		if new_addr == cache {
-			result["number"] = visitor_cache[i].Number
+			is_in_cache = true
 			break
 		}
 	}
@@ -40,19 +35,14 @@ func GET_Metrics(c *fiber.Ctx) error {
 		return util.ErrInternal(c, err)
 	}
 
-	if result["number"] == 0 {
+	if !is_in_cache {
-		result["total"]++
-		result["number"] = result["total"]
-
 		if len(visitor_cache) > VISITOR_CACHE_MAX {
 			util.Debg("visitor cache is full, removing the oldest entry")
 			visitor_cache = visitor_cache[1:]
 		}
 
-		visitor_cache = append(visitor_cache, visitor_cache_entry{
+		visitor_cache = append(visitor_cache, new_addr)
-			Addr:   new_addr,
+		result["total"]++
-			Number: result["number"],
-		})
 
 		if err = db.MetricsSet("visitor_count", result["total"]); err != nil {
 			return util.ErrInternal(c, err)

app/package-lock.json

@@ -9,6 +9,7 @@
       "version": "6.0",
       "dependencies": {
         "@types/dompurify": "^3.2.0",
+        "dompurify": "^3.2.3",
         "marked": "^15.0.6",
         "svelte-i18n": "^4.0.1"
       },
@@ -1092,6 +1093,7 @@
       "version": "3.2.3",
       "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-3.2.3.tgz",
       "integrity": "sha512-U1U5Hzc2MO0oW3DF+G9qYN0aT7atAou4AgI0XjWz061nyBPbdxkfdhfy5uMgGn6+oLFCfn44ZGbdDqCzVmlOWA==",
+      "license": "(MPL-2.0 OR Apache-2.0)",
       "optionalDependencies": {
         "@types/trusted-types": "^2.0.7"
       }

app/package.json

@@ -22,6 +22,7 @@
   "type": "module",
   "dependencies": {
     "@types/dompurify": "^3.2.0",
+    "dompurify": "^3.2.3",
     "marked": "^15.0.6",
     "svelte-i18n": "^4.0.1"
   }

app/src/lib/doc.js

@@ -16,7 +16,7 @@ async function doc_http_get(fetch, url) {
 }
 
 async function doc_get_list(fetch) {
-  return (await doc_http_get(fetch, doc_urljoin("/list")))["list"];
+  return await doc_http_get(fetch, doc_urljoin("/list"));
 }
 
 async function doc_get(fetch, name) {

app/src/lib/footer.svelte

@@ -40,12 +40,12 @@
     <span>
       {$_("footer.number", {
         values: {
-          number: data.number,
+          total: data.total,
           since: date_from_ts(data.since),
         },
       })}
       {#if data.number % 1000 == 0}
-        <span style="color: var(--{color()})">({$_("footer.congrat")})</span>
+        <span style="color: var(--{color()})">({$_("footer.wow")})</span>
       {/if}
     </span>
     <span>

app/src/lib/util.js

@@ -23,20 +23,23 @@ function browser_lang() {
 
 function set_lang(lang) {
   language.set(default_language);
+  locale.set(default_language);
 
   if (lang === null || lang === undefined) {
-    if (browser) set_lang(browser_lang());
+    if (browser && null !== (lang = localStorage.getItem("language"))) set_lang(lang);
+    else if (browser) set_lang(browser_lang());
     return;
   }
 
   lang = lang.slice(0, 2);
 
   for (let i = 0; i < languages.length; i++) {
-    if (lang === languages[i].code) {
+    if (lang !== languages[i].code) continue;
-      language.set(lang);
+
-      locale.set(lang);
+    language.set(lang);
-      return;
+    locale.set(lang);
-    }
+
+    if (browser) localStorage.setItem("language", lang);
   }
 }
 

app/src/locales/en.json

@@ -76,8 +76,8 @@
     "license": "License",
     "privacy": "Privacy",
     "powered": "Powered by Svelte, Go, SQLite and donations",
-    "number": "You are the visitor number {number} since {since}",
+    "number": "Visited {total} times since {since}",
-    "congrat": "congrats!!",
+    "wow": "wow!!",
     "version": "Using API version {api_version}, frontend version {frontend_version}"
   }
 }

app/src/locales/tr.json

@@ -77,8 +77,8 @@
     "license": "Lisans",
     "privacy": "Gizlilik",
     "powered": "Svelte, Go, SQLite ve bağışlar tarafından destekleniyor",
-    "number": "{since} tarihinden beri {number}. ziyaretçisiniz",
+    "number": "{since} tarihinden beri {total} kez ziyaret edildi",
-    "congrat": "tebrikler!!",
+    "wow": "vay be!!",
     "version": "Kullan API versiyonu {api_version}, arayüz versiyonu {frontend_version}"
   }
 }

app/src/routes/+layout.js

@@ -31,7 +31,7 @@ export async function load({ fetch }) {
     };
   } catch (err) {
     return {
-      error: err,
+      error: err.toString(),
     };
   }
 }

app/src/routes/doc/[name]/+page.js

@@ -1,11 +0,0 @@
-import { goto } from "$app/navigation";
-import { doc_get } from "$lib/doc";
-
-export async function load({ fetch, params }) {
-  try {
-    return await doc_get(fetch, params.name);
-  } catch (err) {
-    if (err.toString().includes("not found")) return goto("/");
-    return { error: err };
-  }
-}

app/src/routes/doc/[name]/+page.server.js

@@ -0,0 +1,9 @@
+import { doc_get } from "$lib/doc";
+
+export async function load({ fetch, params }) {
+  try {
+    return { doc: await doc_get(fetch, params.name) };
+  } catch (err) {
+    return { error: err.toString() };
+  }
+}

app/src/routes/doc/[name]/+page.svelte

@@ -2,36 +2,48 @@
   import Header from "$lib/header.svelte";
   import Head from "$lib/head.svelte";
 
-  import { color } from "$lib/util.js";
+  import { language, color } from "$lib/util.js";
+  import { goto } from "$app/navigation";
+  import DOMPurify from "dompurify";
+  import { onMount } from "svelte";
   import { marked } from "marked";
   import { _ } from "svelte-i18n";
 
   let { data } = $props();
   marked.use({ breaks: true });
+
+  onMount(async () => {
+    if (data.error !== null) return await goto("/");
+
+    for (let key in data.doc)
+      data.doc[key]["content"] = DOMPurify.sanitize(data.doc[key]["content"]);
+  });
 </script>
 
 <Head title="documentation" desc="website and API documentation" />
 <Header picture="reader" title={$_("doc.title")} />
 
 <main>
-  <div class="markdown-body" style="--link-color: var(--{color()})">
+  {#if data.doc !== undefined}
-    {@html marked.parse(data.content)}
+    <div class="markdown-body" style="--link-color: var(--{color()})">
-  </div>
+      {@html marked.parse(data.doc[$language].content)}
-  <div class="docs">
+    </div>
-    {#each data.docs as doc}
+    <div class="docs">
-      {#if doc.title == data.title}
+      {#each data.docs[$language] as doc}
-        <a href="/doc/{doc.name}" style="border-color: var(--{color()})">
+        {#if doc.title == data.doc[$language].title}
-          <h1>{doc.title}</h1>
+          <a href="/doc/{doc.name}" style="border-color: var(--{color()})">
-          <h3>{doc.desc}</h3>
+            <h1>{doc.title}</h1>
-        </a>
+            <h3>{doc.desc}</h3>
-      {:else}
+          </a>
-        <a href="/doc/{doc.name}" style="border-color: var(--white-3)">
+        {:else}
-          <h1>{doc.title}</h1>
+          <a href="/doc/{doc.name}" style="border-color: var(--white-3)">
-          <h3>{doc.desc}</h3>
+            <h1>{doc.title}</h1>
-        </a>
+            <h3>{doc.desc}</h3>
-      {/if}
+          </a>
-    {/each}
+        {/if}
-  </div>
+      {/each}
+    </div>
+  {/if}
 </main>
 
 <style>

doc/docs/api.en.json

@@ -0,0 +1,4 @@
+{
+  "title": "API documentation",
+  "desc": "Website's API documentation"
+}

doc/docs/api.en.md

@@ -1,29 +1,26 @@
-The API stores information about the self-hosted services I provide and it also allows me
+My website's API stores information about my self-hosted services, it also allows me to
-to publish news and updates about these services using an Atom feed. It's written in
+publish news and updates about these services using an Atom feed and it keeps track of
-Go and uses SQLite for storage. Licensed under GNU GPL version 3.
+visitor metrics. The API itself is written in Go and uses SQLite for storage.
 
-**Source code and the license is available at**: [https://github.com/ngn13/website](https://github.com/ngn13/website)
+This documentation contains information about all the available API endpoints.
-**You can report issues to**: [https://github.com/ngn13/website/issues](https://github.com/ngn13/website/issues)
-
-The rest of this documentation contains information about all the available API endpoints.
 
 ## Version 1 Endpoints
-Each version 1 endpoint, can be accessed using the /v1 route.
+Each version 1 endpoint, can be accessed using the `/v1` route.
 
 All the endpoints return JSON formatted data.
 
 ### Errors
 If any error occurs, you will get a non-200 response. And the JSON data will have an
-"error" key, which will contain information about the error that occured, in the
+`error` key, which will contain information about the error that occured, in the
 string format. This is the only JSON key that will be set in non-200 responses.
 
 ### Results
-If no error occurs, "error" key will be set to an emtpy string (""). If the endpoint
+If no error occurs, `error` key will be set to an emtpy string (""). If the endpoint
-returns any data, this will be stored using the "result" key. The "result" have a
+returns any data, this will be stored using the `result` key. The `result` have a
 different expected type and a format for each endpoint.
 
 ### Multilang
-Some "result" formats may use a structure called "Multilang". This is a simple JSON
+Some `result` formats may use a structure called "Multilang". This is a simple JSON
 structure that includes one key for each supported language. The key is named after
 the language it represents. Currently only supported languages are:
 - English (`en`)
@@ -38,14 +35,14 @@ Here is an example multilang structure:
   "tr": "Merhaba, dünya!"
 }
 ```
-If a "result" field is using a multilang structure, it will be specified as "Multilang"
+If a `result` field is using a multilang structure, it will be specified as "Multilang"
 in the rest of the documentation.
 
 ### Administrator routes
-The endpoints under the "/v1/admin" route, are administrator-only routes. To access
+The endpoints under the `/v1/admin` route, are administrator-only routes. To access
-these routes you'll need to specfiy and password using the "Authorization" header.
+these routes you'll need to specfiy a password using the `Authorization` header. If
-If the password you specify, matches with the password specified using the
+the password you specify, matches with the password specified using the `API_PASSWORD`
-`API_PASSWORD` environment variable, you will be able to access the route.
+environment variable, you will be able to access the route.
 
 ### GET /v1/services
 Returns a list of available services. Each service has the following JSON format:
@@ -80,7 +77,7 @@ not supported for this service/status checking is disabled (integer, UNIX timest
 - `i2p`: I2P URL for the service (string, empty string if none)
 
 You can also get information about a specific service by specifying it's name using
-a URL query named "name".
+a URL query named `name`.
 
 ### GET /v1/news/:language
 Returns a Atom feed of news for the given language. Supports languages that are supported
@@ -90,19 +87,14 @@ by Multilang.
 Returns metrics about the API usage. The metric data has the following format:
 ```
 {
-  "number":8,
   "since":1736294400,
   "total":8
 }
 ```
 Where:
-- `number`: Visitor number of the the current visitor (integer)
 - `since`: Metric collection start date (integer, UNIX timestamp)
 - `total`: Total number of visitors (integer)
 
-Note that visitor number may change after a certain amount of requests by other clients,
-if the client wants to preserve it's visitor number, it should save it somewhere.
-
 ### GET /v1/admin/logs
 Returns a list of administrator logs. Each log has the following JSON format:
 ```
@@ -115,18 +107,16 @@ Where:
 - `action`: Action that the administrator performed (string)
 - `time`: Time when the administrator action was performed (integer, UNIX timestamp)
 
-Client can get the logs for only a single address, by setting the URL query "addr".
-
 ### PUT /v1/admin/service/add
 Creates a new service. The request body needs to contain JSON data, and it needs to
-have the JSON format used to represent a service. See "/v1/services/all" route to
+have the JSON format used to represent a service. See `/v1/services/all` route to
 see this format.
 
 Returns no data on success.
 
 ### DELETE /v1/admin/service/del
 Deletes a service. The client needs to specify the name of the service to delete, by
-setting the URL query "name".
+setting the URL query `name`.
 
 Returns no data on success.
 
@@ -162,6 +152,6 @@ Returns no data on success.
 
 ### DELETE /v1/admin/news/del
 Deletes a news post. The client needs to specify the ID of the news post to delete,
-by setting the URL query "id".
+by setting the URL query `id`.
 
 Returns no data on success.

doc/docs/api.json

@@ -1,4 +0,0 @@
-{
-  "title": "API documentation",
-  "desc": "Website API documentation"
-}

doc/docs/api.tr.json

@@ -0,0 +1,4 @@
+{
+  "title": "API dökümantasyonı",
+  "desc": "Websitesinin API dökümantasyonı"
+}

doc/docs/api.tr.md

@@ -0,0 +1,159 @@
+Websitemin API self-host edilen servisler hakkında bilgileri tutuyor, bu servisler hakkında
+haberleri ve güncellemeleri bir Atom feed'i aracılığı ile paylaşmama izin veriyor ve ziyartçi
+metriklerini takip ediyor. API'ın kendisi Go ile yazıldı ve veritabanı olarak SQLite kullanıyor.
+
+Bu dökümentasyon tüm erişeme açık API endpoint'leri hakkında bilgiler içeriyor.
+
+## Versyion 1 Endpoint'leri
+Tüm versiyon 1 endpoint'leri `/v1` yolu ile erişilebilir.
+
+Tüm endpoint'ler JSON ile formatlanmış veri döndürür.
+
+### Hatalar
+Herhangi bir hata ortaya çıkarsa 200 dışı bir cevap alırsınız. Ve JSON verisinde
+bir `error` girdisi bulunur, bu ortaya çıkan hata hakkında gerekli bilgileri, metin formunda
+içerir. 200 dışı bir cevap aldığınızda tek JSON girdisi bu olacaktır.
+
+### Sonuçlar
+Eğer bir hata ortaya çıkmaz ise, `error` girdisi boş bir metin olarak ayarlanır ("").
+Eğer endpoint herhangi bir veri döndürüyorsa, bu veri `result` giridisi ile sağlanır.
+Her endpoint için `result` girdisinin tipi farklı olabilir.
+
+### Multilang
+Bazı `result` formatları "Multilang" isimli bir yapıyı kullanabilir. Bu her desteklenen
+dil için bir girdi bulunduran basit bir JSON yapısıdır. Her girdi ifade ettiği dil
+ile isimlendirilir. Şuan tek desteklenen diller:
+- English (`en`)
+- Turkish (`tr`)
+
+Yani her multilang yapısında, bu girdilerden **en az** bir tanesi bulunur.
+
+İşte örnek bir multilang yapısı:
+```
+{
+  "en": "Hello, world!",
+  "tr": "Merhaba, dünya!"
+}
+```
+Bu dökümantasyonun geri kalanında, eğer bir `result` girdisi bir multilang yapısı kullanıyorsa,
+"Multilang" olarak isimlendirilecek.
+
+### Yönetici yolları
+`/v1/admin` yolu altındaki endpoint'ler yöneticiye-özeldir. Bu yollara erişmek için,
+`Authorization` header'ı aracılığı ile bir parola belirtmeniz gerekecektir. Eğer
+belritiğiniz parola `API_PASSWORD` ortam değişkeni ile belirtilen parola ile
+uyuşuyorsa, yola erişebilirsiniz.
+
+### GET /v1/services
+Erişilebilir servislerin bir listesini döndürür. Her servis şu JSON formatını
+takip eder:
+```
+{
+  "name": "Test Service",
+  "desc": {
+    "en": "Service used for testing the API",
+    "tr": "API'ı test etmek için kullanılan servis"
+  },
+  "check_time": 1735861944,
+  "check_res": 1,
+  "check_url": "http://localhost:7001",
+  "clear": "http://localhost:7001",
+  "onion": "",
+  "i2p": ""
+}
+```
+Burada:
+- `name`: Servis ismi (metin)
+- `desc`: Servis açıklaması (Multilang)
+- `check_time`: Servisin en son durumunun kontrol edildiği zaman, eğer bu servis için
+durum kontrolü desteklenmiyorsa/durum kontrolü devra dışı bırakılmış ise 0 olarak
+ayarlanır (sayı, UNIX zaman damgası)
+- `check_res`: En son servis durum kontrolünün sonucu (sayı)
+  * servis kapalı ise 0
+  * servis çalışıyor ise 1
+  * serivs çalışıyor, ama yavaş ise 2
+  * bu servis için durum kontrolü desteklenmiyorsa/durum kontrolü devre dışı ise 3
+- `check_url`: Servis durum kontrolü için kullanılan URL (metin, yoksa boş metin)
+- `clear`: Servisin açık ağ URL'si (metin, yoksa boş metin)
+- `onion`: Servisin Onion (TOR) URL'si (metin, yoksa boş metin)
+- `i2p`: Servisin I2P URL'si (metin, yoksa boş metin)
+
+`name` isimli bir URL sorgusu ile servisin ismini belirterek, spesifik bir servis hakkında
+bilgi de alabilirsiniz.
+
+### GET /v1/news/:language
+Verilen dil için haberlerin bir Atom feed'i döndürür. Multilang tarafından desteklenen
+dilleri destekler.
+
+### GET /v1/metrics
+API kullanımı hakkınadaki metrikleri döndürür. Metrik şu formatı kullanır:
+```
+{
+  "since":1736294400,
+  "total":8
+}
+```
+Burada:
+- `since`: Metrik toplama başlangıç tarihi (sayı, UNIX zaman damgası)
+- `total`: Toplam ziyaretçi sayısı (sayı)
+
+### GET /v1/admin/logs
+Yönetici kayıtlarının bir listesini döndürür. Her kayıt şu JSON formatını takip eder:
+```
+{
+  "action": "Added service \"Test Service\"",
+  "time": 1735861794
+}
+```
+Burada:
+- `action`: Yöneticinin yaptığı eylem (metin)
+- `time`: Yönetici eylemin yapıldığı zaman (sayı, UNIX zaman damgası)
+
+### PUT /v1/admin/service/add
+Yeni bir servis oluşturur. İstek gövdesinin servis için kullanılan JSON formatını
+takip eden JSON verisini içermesi gerekir. Bu formatı görmek için `/v1/services/all`
+yoluna bakınız.
+
+Başarılı ise herhangi bir veri döndürmez.
+
+### DELETE /v1/admin/service/del
+Bir servisi siler. İstemcinin `name` URL sorgusu ile silinecek servisin ismini belirtmesi
+gerekir.
+
+Başarılı ise herhangi bir veri döndürmez.
+
+### GET /v1/admin/service/check
+Tüm servisler için bir durum kontrolünü zorlar.
+
+Başarılı ise herhangi bir veri döndürmez.
+
+### PUT /v1/admin/news/add
+Yeni bir haber paylaşımı oluşturur. İstek gövedisinin JSOn verisi içermesi ve verilen formatı
+takip etmesi gerekir:
+```
+{
+  "id": "test_news",
+  "title": {
+    "en": "Very important news",
+    "tr": "Çok önemli haber"
+  },
+  "author": "ngn",
+  "content": {
+    "en": "Just letting you know that I'm testing the API",
+    "tr": "Sadece API'ı test ettiğimi bilmenizi istedim"
+  }
+}
+```
+Burada:
+- `id`: Haber paylaşımının benzersiz ID'si (metin)
+- `title`: Haber paylaşımının başlığı (Multilang)
+- `author`: Haber paylaşımının yazarı (metin)
+- `content`: Haber paylaşımının içerği (Multilang)
+
+Başarılı ise herhangi bir veri döndürmez.
+
+### DELETE /v1/admin/news/del
+Bir haber paylaşımı siler. İstemcinin `id` URL sorgusu ile silinecek paylaşımın ID'sini
+belirtmesi gerekir.
+
+Başarılı ise herhangi bir veri döndürmez.

doc/docs/license.tr.json

@@ -0,0 +1,4 @@
+{
+  "title": "Lisans",
+  "desc": "Kaynak kodu lisansı"
+}

doc/docs/license.tr.md

@@ -0,0 +1,675 @@
+# GNU GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+## Preamble
+
+The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom
+to share and change all versions of a program--to make sure it remains
+free software for all its users. We, the Free Software Foundation, use
+the GNU General Public License for most of our software; it applies
+also to any other work released this way by its authors. You can apply
+it to your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you
+have certain responsibilities if you distribute copies of the
+software, or if you modify it: responsibilities to respect the freedom
+of others.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the
+manufacturer can do so. This is fundamentally incompatible with the
+aim of protecting users' freedom to change the software. The
+systematic pattern of such abuse occurs in the area of products for
+individuals to use, which is precisely where it is most unacceptable.
+Therefore, we have designed this version of the GPL to prohibit the
+practice for those products. If such problems arise substantially in
+other domains, we stand ready to extend this provision to those
+domains in future versions of the GPL, as needed to protect the
+freedom of users.
+
+Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish
+to avoid the special danger that patents applied to a free program
+could make it effectively proprietary. To prevent this, the GPL
+assures that patents cannot be used to render the program non-free.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+## TERMS AND CONDITIONS
+
+### 0. Definitions.
+
+"This License" refers to version 3 of the GNU General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+### 1. Source Code.
+
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same
+work.
+
+### 2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
+
+### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
+
+### 4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+### 5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these
+conditions:
+
+-   a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+-   b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under
+    section 7. This requirement modifies the requirement in section 4
+    to "keep intact all notices".
+-   c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy. This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged. This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+-   d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+### 6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
+
+-   a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+-   b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the Corresponding
+    Source from a network server at no charge.
+-   c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source. This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+-   d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge. You need not require recipients to copy the
+    Corresponding Source along with the object code. If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source. Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+-   e) Convey the object code using peer-to-peer transmission,
+    provided you inform other peers where the object code and
+    Corresponding Source of the work are being offered to the general
+    public at no charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal,
+family, or household purposes, or (2) anything designed or sold for
+incorporation into a dwelling. In determining whether a product is a
+consumer product, doubtful cases shall be resolved in favor of
+coverage. For a particular product received by a particular user,
+"normally used" refers to a typical or common use of that class of
+product, regardless of the status of the particular user or of the way
+in which the particular user actually uses, or expects or is expected
+to use, the product. A product is a consumer product regardless of
+whether the product has substantial commercial, industrial or
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to
+install and execute modified versions of a covered work in that User
+Product from a modified version of its Corresponding Source. The
+information must suffice to ensure that the continued functioning of
+the modified object code is in no case prevented or interfered with
+solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or
+updates for a work that has been modified or installed by the
+recipient, or for the User Product in which it has been modified or
+installed. Access to a network may be denied when the modification
+itself materially and adversely affects the operation of the network
+or violates the rules and protocols for communication across the
+network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+### 7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders
+of that material) supplement the terms of this License with terms:
+
+-   a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+-   b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+-   c) Prohibiting misrepresentation of the origin of that material,
+    or requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+-   d) Limiting the use for publicity purposes of names of licensors
+    or authors of the material; or
+-   e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+-   f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions
+    of it) with contractual assumptions of liability to the recipient,
+    for any liability that these contractual assumptions directly
+    impose on those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions; the
+above requirements apply either way.
+
+### 8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+### 9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or run
+a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+### 10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+### 11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims owned
+or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within the
+scope of its coverage, prohibits the exercise of, or is conditioned on
+the non-exercise of one or more of the rights that are specifically
+granted under this License. You may not convey a covered work if you
+are a party to an arrangement with a third party that is in the
+business of distributing software, under which you make payment to the
+third party based on the extent of your activity of conveying the
+work, and under which the third party grants, to any of the parties
+who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by
+you (or copies made from those copies), or (b) primarily for and in
+connection with specific products or compilations that contain the
+covered work, unless you entered into that arrangement, or that patent
+license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+### 12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under
+this License and any other pertinent obligations, then as a
+consequence you may not convey it at all. For example, if you agree to
+terms that obligate you to collect a royalty for further conveying
+from those to whom you convey the Program, the only way you could
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
+
+### 13. Use with the GNU Affero General Public License.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+### 14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in
+detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU General Public
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that numbered version or
+of any later version published by the Free Software Foundation. If the
+Program does not specify a version number of the GNU General Public
+License, you may choose any version ever published by the Free
+Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions
+of the GNU General Public License can be used, that proxy's public
+statement of acceptance of a version permanently authorizes you to
+choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+### 15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+### 16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+### 17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+## How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+        <one line to give the program's name and a brief idea of what it does.>
+        Copyright (C) <year>  <name of author>
+
+        This program is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 3 of the License, or
+        (at your option) any later version.
+
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+
+        You should have received a copy of the GNU General Public License
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+        <program>  Copyright (C) <year>  <name of author>
+        This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+        This is free software, and you are welcome to redistribute it
+        under certain conditions; type `show c' for details.
+
+The hypothetical commands \`show w' and \`show c' should show the
+appropriate parts of the General Public License. Of course, your
+program's commands might be different; for a GUI interface, you would
+use an "about box".
+
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU GPL, see <https://www.gnu.org/licenses/>.
+
+The GNU General Public License does not permit incorporating your
+program into proprietary programs. If your program is a subroutine
+library, you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+GNU Lesser General Public License instead of this License. But first,
+please read <https://www.gnu.org/licenses/why-not-lgpl.html>.

doc/inc/docs.h

@@ -0,0 +1,18 @@
+#pragma once
+#include <linux/limits.h>
+#include <stdbool.h>
+#include <dirent.h>
+
+#include "util.h"
+
+typedef struct {
+  DIR         *dir;
+  util_file_t *file;
+  char         name[NAME_MAX + 1];
+  char        *lang;
+} docs_t;
+
+bool  docs_init(docs_t *docs, char *dir);
+char *docs_next(docs_t *docs, char *name, bool content);
+void  docs_reset(docs_t *docs);
+void  docs_free(docs_t *docs);

doc/inc/util.h

@@ -9,15 +9,11 @@ typedef struct {
   uint64_t size;
 } util_file_t;
 
-#define util_compare_name(n1, n2) (strncmp(n1, n2, NAME_MAX) == 0)
 #define util_toupper(str)                                                                                              \
   for (char *c = str; *c != 0; c++)                                                                                    \
   *c = toupper(*c)
-#define util_tolower(str)                                                                                              \
-  for (char *c = str; *c != 0; c++)                                                                                    \
-  *c = tolower(*c)
 uint64_t     util_endswith(char *str, char *suf);
 void         util_send(ctorm_res_t *res, uint16_t code, cJSON *json);
-bool         util_dir_contains(char *dir, const char *file);
+util_file_t *util_file_load(int dirfd, char *path);
-util_file_t *util_file_load(char *path);
 void         util_file_free(util_file_t *file);
+bool         util_parse_doc_name(char *name, char **lang, const char *ext);

doc/src/docs.c

@@ -0,0 +1,106 @@
+#include <linux/limits.h>
+#include <dirent.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdint.h>
+
+#include "util.h"
+#include "docs.h"
+
+#define DOCS_LANG_CODE_LEN 2
+
+bool __docs_parse_name(docs_t *docs, char *ext) {
+  // check the extension
+  uint64_t ext_pos = util_endswith(docs->name, ext);
+
+  if (ext_pos == 0)
+    return false;
+
+  // example.en.json\0 => example.en\0json\0
+  docs->name[ext_pos] = 0;
+
+  // example.en\0json\0
+  //        |
+  //        `--- find this
+  for (docs->lang = docs->name; *docs->lang != 0 && *docs->lang != '.'; docs->lang++)
+    continue;
+
+  if (*docs->lang != '.')
+    return false;
+
+  // example.en\0json\0 => example.en\0json\0
+  *docs->lang++ = 0;
+
+  // example\0en\0json
+  // |        |   |
+  // |        |   `--- ext_pos
+  // |        `-- lang
+  // `-- name
+  return strlen(docs->lang) == DOCS_LANG_CODE_LEN && *docs->name != 0;
+}
+
+void __docs_clean(docs_t *docs) {
+  if (NULL == docs->file)
+    return;
+
+  util_file_free(docs->file);
+  docs->file = NULL;
+}
+
+bool docs_init(docs_t *docs, char *dir) {
+  if (NULL == docs || NULL == dir) {
+    errno = EINVAL;
+    return false;
+  }
+
+  bzero(docs, sizeof(*docs));
+  return NULL != (docs->dir = opendir(dir));
+}
+
+char *docs_next(docs_t *docs, char *name, bool content) {
+  if (NULL == docs) {
+    errno = EINVAL;
+    return false;
+  }
+
+  struct dirent *ent = NULL;
+  __docs_clean(docs);
+
+  while (NULL != (ent = readdir(docs->dir))) {
+    if (*ent->d_name == '.')
+      continue;
+
+    strcpy(docs->name, ent->d_name);
+
+    if (!__docs_parse_name(docs, content ? ".md" : ".json"))
+      continue;
+
+    if (NULL == name || strncmp(docs->name, name, NAME_MAX) == 0)
+      break;
+  }
+
+  if (NULL == ent) {
+    errno = ENOENT;
+    return NULL;
+  }
+
+  if (NULL == (docs->file = util_file_load(dirfd(docs->dir), ent->d_name)))
+    return NULL;
+
+  return docs->file->content;
+}
+
+void docs_reset(docs_t *docs) {
+  if (NULL != docs)
+    rewinddir(docs->dir);
+}
+
+void docs_free(docs_t *docs) {
+  if (NULL == docs)
+    return;
+
+  __docs_clean(docs);
+  closedir(docs->dir);
+
+  bzero(docs, sizeof(*docs));
+}

doc/src/routes/get.c

@@ -1,3 +1,5 @@
+#include <cjson/cJSON.h>
+#include <dirent.h>
 #include <linux/limits.h>
 #include <ctorm/ctorm.h>
 
@@ -7,72 +9,62 @@
 
 #include "routes.h"
 #include "config.h"
-#include "util.h"
+#include "docs.h"
 
 void route_get(ctorm_req_t *req, ctorm_res_t *res) {
-  config_t   *conf     = REQ_LOCAL("config");
+  config_t *conf     = REQ_LOCAL("config");
-  char       *docs_dir = config_get(conf, "docs_dir");
+  char     *doc_name = REQ_PARAM("name");
-  const char *name     = REQ_PARAM("name");
+  char     *docs_dir = config_get(conf, "docs_dir"), *doc_data = NULL;
+  cJSON    *json = NULL, *doc_json = NULL;
+  docs_t    docs;
 
-  if (NULL == name) {
+  if (NULL == doc_name) {
-    ctorm_fail("doc name is not specified");
+    ctorm_fail("documentation name not specified (how did that even happend)");
-    return util_send(res, 500, NULL);
+    util_send(res, 500, NULL);
+    goto end;
   }
 
-  if (strlen(name) > NAME_MAX - 6)
+  if (!docs_init(&docs, docs_dir)) {
-    return util_send(res, 404, NULL);
+    ctorm_fail("docs_init failed: %s", ctorm_geterror());
+    util_send(res, 500, NULL);
+    goto end;
+  }
 
-  char         full_path[PATH_MAX + 1], full_name[NAME_MAX + 1];
+  if (NULL == (json = cJSON_CreateObject())) {
-  util_file_t *doc_file = NULL, *json_file = NULL;
+    ctorm_fail("failed to create cJSON object");
-  cJSON       *doc_json = NULL;
+    util_send(res, 500, NULL);
+    goto end;
+  }
 
-  // read the doc markdown
+  while (NULL != (doc_data = docs_next(&docs, doc_name, false))) {
-  snprintf(full_name, sizeof(full_name), "%s.md", name);
+    if (NULL == (doc_json = cJSON_Parse(doc_data))) {
-  snprintf(full_path, sizeof(full_path), "%s/%s", docs_dir, full_name);
+      ctorm_fail("failed to parse JSON: %s (%s)", docs.name, docs.lang);
+      continue;
+    }
 
-  if (!util_dir_contains(docs_dir, full_name)) {
+    cJSON_AddStringToObject(doc_json, "content", "");
+    cJSON_AddItemToObject(json, docs.lang, doc_json);
+  }
+
+  if (NULL == doc_json) {
     util_send(res, 404, NULL);
     goto end;
   }
 
-  if (NULL == (doc_file = util_file_load(full_path))) {
+  docs_reset(&docs);
-    ctorm_fail("failed to load file: %s", full_path);
+
-    util_send(res, 500, NULL);
+  while (NULL != (doc_data = docs_next(&docs, doc_name, true))) {
-    goto end;
+    if (NULL == (doc_json = cJSON_GetObjectItem(json, docs.lang)))
+      continue;
+
+    cJSON_DeleteItemFromObject(doc_json, "content");
+    cJSON_AddStringToObject(doc_json, "content", doc_data);
   }
 
-  // read the doc JSON
+  util_send(res, 200, json);
-  snprintf(full_name, sizeof(full_name), "%s.json", name);
-  snprintf(full_path, sizeof(full_path), "%s/%s", docs_dir, full_name);
-
-  if (!util_dir_contains(docs_dir, full_name)) {
-    util_send(res, 404, NULL);
-    goto end;
-  }
-
-  if (NULL == (json_file = util_file_load(full_path))) {
-    ctorm_fail("failed to load file: %s", full_path);
-    util_send(res, 500, NULL);
-    goto end;
-  }
-
-  // parse the doc JSON
-  if (NULL == (doc_json = cJSON_Parse(json_file->content))) {
-    ctorm_fail("failed to parse file: %s", full_path);
-    util_send(res, 500, NULL);
-    goto end;
-  }
-
-  cJSON_AddStringToObject(doc_json, "content", doc_file->content);
-  util_send(res, 200, doc_json);
 
 end:
-  if (NULL != doc_file)
+  docs_free(&docs);
-    util_file_free(doc_file);
+  if (NULL != json)
-
+    cJSON_Delete(json);
-  if (NULL != json_file)
-    util_file_free(json_file);
-
-  if (NULL != doc_json)
-    cJSON_free(doc_json);
 }

doc/src/routes/list.c

@@ -1,72 +1,53 @@
 #include <linux/limits.h>
+#include <cjson/cJSON.h>
 #include <ctorm/ctorm.h>
 
 #include <dirent.h>
 #include <string.h>
 #include <stdio.h>
 
-#include "util.h"
+#include "routes.h"
 #include "config.h"
+#include "docs.h"
 
 void route_list(ctorm_req_t *req, ctorm_res_t *res) {
   config_t *conf     = REQ_LOCAL("config");
-  char     *docs_dir = config_get(conf, "docs_dir");
+  char     *docs_dir = config_get(conf, "docs_dir"), *doc_data = NULL;
+  cJSON    *array = NULL, *json = NULL, *doc_json = NULL;
+  docs_t    docs;
 
-  cJSON *array = NULL, *json = NULL;
+  if (!docs_init(&docs, docs_dir)) {
-  DIR   *docs_dir_fd = NULL;
+    ctorm_fail("docs_init failed: %s", ctorm_geterror());
-
+    util_send(res, 500, NULL);
-  if (NULL == (array = cJSON_CreateArray())) {
+    goto end;
-    ctorm_fail("failed to create cJSON array");
-    return util_send(res, 500, NULL);
   }
 
-  if (NULL == (docs_dir_fd = opendir(docs_dir))) {
-    ctorm_fail("failed to open the docs dir (%s): %s", docs_dir, ctorm_geterror());
-    return util_send(res, 500, NULL);
-  }
-
-  char           doc_path[PATH_MAX + 1], doc_name[NAME_MAX + 1];
-  util_file_t   *doc_file = NULL;
-  struct dirent *doc      = NULL;
-  uint64_t       ext_indx = 0;
-
-  while (NULL != (doc = readdir(docs_dir_fd))) {
-    if ((ext_indx = util_endswith(doc->d_name, ".json")) == 0)
-      continue;
-
-    snprintf(doc_path, sizeof(doc_path), "%s/%s", docs_dir, doc->d_name);
-
-    if (NULL == (doc_file = util_file_load(doc_path))) {
-      ctorm_fail("failed to load the JSON file: %s", doc_path);
-      goto next;
-    }
-
-    if (NULL == (json = cJSON_Parse(doc_file->content))) {
-      ctorm_fail("failed to parse the JSON file: %s", doc_path);
-      goto next;
-    }
-
-    strcpy(doc_name, doc->d_name);
-    util_tolower(doc_name);
-    doc_name[ext_indx] = 0;
-
-    cJSON_AddStringToObject(json, "name", doc_name);
-    cJSON_AddItemToArray(array, json);
-
-  next:
-    if (NULL != doc_file)
-      util_file_free(doc_file);
-    doc_file = NULL;
-  }
-
-  closedir(docs_dir_fd);
-
   if (NULL == (json = cJSON_CreateObject())) {
     ctorm_fail("failed to create cJSON object");
-    return util_send(res, 500, NULL);
+    util_send(res, 500, NULL);
+    goto end;
+  }
+
+  while (NULL != (doc_data = docs_next(&docs, NULL, false))) {
+    if (NULL == (array = cJSON_GetObjectItem(json, docs.lang)) &&
+        NULL == (array = cJSON_AddArrayToObject(json, docs.lang))) {
+      ctorm_fail("failed to create an array object for the language %s", docs.lang);
+      continue;
+    }
+
+    if (NULL == (doc_json = cJSON_Parse(doc_data))) {
+      ctorm_fail("failed to parse JSON: %s (%s)", docs.name, docs.lang);
+      continue;
+    }
+
+    cJSON_AddStringToObject(doc_json, "name", docs.name);
+    cJSON_AddItemToArray(array, doc_json);
   }
 
-  cJSON_AddItemToObject(json, "list", array);
   util_send(res, 200, json);
-  cJSON_free(json);
+
+end:
+  docs_free(&docs);
+  if (NULL != json)
+    cJSON_Delete(json);
 }

doc/src/util.c

@@ -58,31 +58,7 @@ void util_send(ctorm_res_t *res, uint16_t code, cJSON *json) {
   RES_JSON(json);
 }
 
-bool util_dir_contains(char *dir, const char *file) {
+util_file_t *util_file_load(int dirfd, char *path) {
-  if (NULL == dir || NULL == file) {
-    errno = EINVAL;
-    return false;
-  }
-
-  struct dirent *dirent = NULL;
-  DIR           *dirfd  = NULL;
-
-  if (NULL == (dirfd = opendir(dir)))
-    return false; // errno set by opendir
-
-  while ((dirent = readdir(dirfd)) != NULL) {
-    if (util_compare_name(dirent->d_name, ".") || util_compare_name(dirent->d_name, ".."))
-      continue;
-
-    if (util_compare_name(dirent->d_name, file))
-      break;
-  }
-
-  closedir(dirfd);
-  return NULL != dirent;
-}
-
-util_file_t *util_file_load(char *path) {
   if (NULL == path) {
     errno = EINVAL;
     return NULL;
@@ -95,7 +71,7 @@ util_file_t *util_file_load(char *path) {
   if (NULL == (file = malloc(sizeof(util_file_t))))
     goto end; // errno set by malloc
 
-  if ((fd = open(path, O_RDONLY)) < 0)
+  if ((fd = openat(dirfd, path, O_RDONLY)) < 0)
     goto end; // errno set by open
 
   if (fstat(fd, &buf) < 0)