GeoGet

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== LabForGg ======
S příchodem aplikace pro mobilní telefony není možné rozumným způsobem získat informace o Adventure LAB keších a jejich sériích. To sice není problém při vlastním "odehrávání", ale problém nastává při plánování odlovu zejména spolu s ostatním typem keší nebo při generování statistik. Adventure LAB keše jsou vedeny u geocaching.com zcela samostatně, a jiný přístup než přes mobilní aplikaci není možný.

Proto pod vedením [[https://www.geocaching.com/p/default.aspx?guid=4e203113-6deb-4a4e-8634-28f65af2e482|tuláka]] a ve spolupráci s [[https://www.geocaching.com/p/default.aspx?guid=ad727be2-2acb-4d5a-8783-37df0076c897|georabbits.cz]], [[https://www.geocaching.com/p/default.aspx?guid=35cb25c7-e365-4665-9ad8-5bbb9da2ce64&wid=cdb83e8f-1432-481a-bd29-fb5b05ee978d|Jazzlinka]] vznikl postupně [[https://labgpx.cz/|server s GPX soubory Adventure LAB keší]]. Na tomto serveru je možné získat jednotlivé soubory s Adventure LAB kešemi, tyto soubory nahrát do GPS nebo do nějaké aplikace a víceméně s nimi pracovat podobně jako s ostatními typy keší.

Skript LabForGg pak slouží k automatizovanému přístupu na tento server s možností přímého importu dat do GeoGetu.

Druhým využitím skriptu pak je možnost tvorby GPX souboru s Adventure LAB kešemi a jejich nahrání na server, ovšem tato činnost je dostupná jen správcům po zadání autorizačních informací.

===== Autor =====
  * **[[http://www.geocaching.com/profile/?u=gordici|Gord]]**, **[[gord@atlas.cz|Gord]]**

===== Automatická instalace =====
~~GEOGET_INSTALL~~

===== Popis =====

<WRAP center round tip>
Videonávod s možnostmi a ovládáním pluginu [[https://www.youtube.com/watch?v=RzvEYjxRwhM|najdete na YouTube]].
</WRAP>


Skript umožňuje vyhledávat Adventure LAB keše (resp. jejich série) podle různých kritérií se stejnými možnostmi jako přes webové rozhraní:
  * podle GC kódu rodičovské keše
  * podle jména série Adventure LAB keší
  * podle autora série Adventure LAB keší
  * podle státu nebo území ve státě
  * podle data a času publikace GPX souboru se sérií Adventure LAB keší na serveru
  * podle dalších příznaků
    * k sérii existuje bonusová keš (většinou mysterka), ta je zároveň rodičovskou keší
    * série je sekvenční (autor Adventure LAB keší pevně stanovil pořadí, v kterém je třeba jednotlivé Adventure LAB keše série navštívit)
    * série byla publikovaná k nějakému eventu (ten pak bývá rodičovskou keší)
    * série byla archivována
  * podle autora GPX souboru, tedy toho, kdo GPX soubor na server nahrál

U skriptu však navíc přibývají možnosti:
  * importovat keše, které byly na server doplněny (nebo upraveny) po určitém datu
  * importovat jen keše, které dosud nejsou v GeoGetu
  * pamatovat si datum posledního importu dat ze serveru (pro každou databázi samostatně)

Tyto funkce jsou tak nástrojem pro snadné udržení aktuálních informací o všech Adventure LAB keších v GeoGetu.

<WRAP center round tip 95%>
Všechny texty, podle kterých je na serveru hledáno, jsou chápany jako součást položky, ve které se hledá, a vyhledávání probíhá bez ohledu na velikost písmen a diakritiku tak, jak jsme v GeoGetu zvyklí.

Pokud tedy do položky pro autora série zadám jen písmeno **e**, pak budou vyhledány např. autor Demkes, Démoníci, Děd vševěd i Eliška.
</WRAP>

/*
===== Nastavení nálezu Adventure LAB keší pro statistiky =====
Pro statistiky tvořené v GeoGetu je důležité, aby keše byly označené jako nalezené. Nastavit nález je možné pro jednotlivé keše nebo i pro označenou skupinu keší přes kontextové menu dostupné pravým myšítkem na kešce v zobrazeném seznamu keší.

<WRAP center round important 95%>
Pokud máte ve Statoru nastaveno řazení podle data a času, je nutné u nálezu Adventure LAB keše zadávat i čas (odlišný od 00:00). Nezadáte-li jej, nebudou keše např. započteny do milníků.
</WRAP>
*/
===== Ukázka =====
{{:user:skript:labforgg:labforgg-main.jpg?400|Hlavní obrazovka - vyhledávání ne serveru}}

Na obrázku je vidět možnosti vyhledávání. Ve **vyhledávacím profilu** lze vybrat předvolené vlastnosti pro vyhledávání. Po kliknutí na tlačítko Vyhledat se ve spodním seznamu zobrazí série odpovídající vyhledávacím kritériím. Pak tlačítkem **Stáhnout** lze v seznamu vybrané série stáhnout (jako GPX soubor) nebo rovnou importovat do databáze GeoGetu.

Zaškrtávací políčko **Zapamatovat čas importu** slouží k tomu, aby si plugin poznamenal aktuální datum a čas a tím pak příště předvyplnil datum a čas pro vyhledávání. Snadno tak lze nalézt a získat jen série, které byly od poslední aktualizace doplněny nebo změněny, a udržovat tak data v databázi aktuální.

<WRAP center round tip>
Vyhledávací profil si můžete upravovat, přidávat své vlastní profily, ... Plugin při svém spuštění použije první profil, který v INI souboru najde. Pokud tedy chcete, aby byl po spuštění aktivní nějaký konkrétní profil, přesuňte jej v souboru ''LabForGg.ini'' na začátek.
</WRAP>

Z vlastní zkušenosti pro udržování aktuálního stavu sérií v databázi GeoGetu doporučuji

  * použít vhodné nastavení oblasti (stát, kraj)
  * mít zaškrtnuté ''publikované/změněné v/po'', ''importovat do GeoGetu'' a ''zapamatovat čas importu''
  * takto si vyhledávací profil uložit
  * pak kliknete na **Vyhledat**, vyberete všechny série (CTRL+A) a tlačítkem **Stáhnout** importujete data


===== Nastavení pluginu =====

Pro běžné používání není třeba žádné speciální nastavení, vše by mělo pracovat hned po instalaci.
  * WEB_URL je adresa pro komunikaci se serverem a je nastavená již při instalaci

Jinak je tomu u autorů GPX. V souboru ''LabForGg.config.pas'' je nutné nastavit hodnoty:
  * WEBPUB_URL
  * WEBPUB_USER
  * WEBPUB_PWD
  * a případně GPX_AUTHOR_ENABLE (tato hodnota je používaná jen v případě Adventure LAB keší existujících ještě před vytvořením serveru pro sdílení GPX souborů, aby bylo možné zachovat autora původního GPX souboru)

Všechny hodnoty, kromě poslední, přiděluje správce serveru s GPX soubory. Bez jejich smysluplného zadání nebudou v pluginu dostupné funkce pro tvorbu GPX souboru a jeho nahrání na server.

Položka ''SAVE_DIR'' slouží k tomu, aby si uživatel mohl definovat adresář, do kterého bude plugin vytvořené GPX soubory ukládat. Pokud adresář není vyplněn, plugin použije ''DATADIR''.

===== Tvorba GPX =====
Protože při tvorbě GPX je potřeba dodržet některá pravidla, lze na serveru zveřejnit jen GPX soubory vytvořené tímto skriptem.

Aby nedocházelo ke konfliktům a problémům při zpracování, musejí autoři GPX souborů navíc dodržet některá pravidla pro jejich tvorbu. Z toho důvodu je přístup k funkcím pro tvorbu GPX souborů a jejich nahrání na server chráněn a je třeba skript do takového režimu nastavit.

Plugin umožňuje:

  - pomocí API vyhledat na originálním serveru série kolem zadaných souřadnic nebo ve vybrané oblasti
  - z nalezených sérií vybrat jednu, přenést ji to formuláře pro tvorbu GPX souboru
  - doplnit k sérii některé další vlastnosti (např. GC kód rodičovské keše) a případně upravit hodnoty získané přes API
  - vytvořit GPX soubor s LAB kešemi v sérii
  - importovat GPX do databáze GeoGetu
  - nahrát GPX soubor na webový server a tím jej zpřístupnit všem

{{:user:skript:labforgg:labforgg-api.jpg?400|Načtené série}} {{:user:skript:labforgg:labforgg-gpx.jpg?400|Série připravená k exportu do GPX souboru}}

==== Pravidla pro tvorbu GPX souborů ====

Pro orientaci v GPX souborech jsou důležité:
  * GC kód rodičovské keše (viz dále Číslování sérií)
  * jméno série
    * musí být v celém souboru jedinečné. Jak plugin, tak server toto kontroluje. Pokud by byla vytvořena série se stejným jménem ale jiným GC kódem, bude systémem vyhodnocena jako série se změněnou rodičovskou keší
    * nesmí obsahovat znak / (lomítko) nebo ' (apostrof). Pokud jméno série od jejího autora tyto znaky, je třeba je nahradit nějakými jinými vhodnými znaky (''-,;'' a podobně) nebo jméno nějak upravit
  * jméno Adventure LAB keše je tvořeno jménem série a jménem vlastní keše ve tvaru ''série/keš''
  * popis série je společný pro všechny keše a je uložen v položce ''ShortDescription'', popis jednotlivých keší je samostatně u každé uložen v položce ''LongDescription''
  * před vytvořením GPX souboru by měl být vyžádán souhlas autora série
    * pokud autor (sekvenční) série nesouhlasí se zveřejněním GPX souboru, měl by GPX soubor obsahovat jen ty údaje, které jsou snadno zjistitelné z mobilní aplikace před odehráním
    * jen první keš série bude správně pojmenovaná, ostatní budou pojmenovány jen pořadovým číslem
    * pravděpodobně jen první keš série bude mít správné souřadnice, ostatní budou mít souřadnice shodné s tou první keší

Pro snadnější získání informací společných pro všechny keše série je možné načíst hodnoty z rodičovské keše tlačítkem **Vlastnosti z GG**.

V případě, že série už v databázi GeoGetu je, lze načíst celou sérii najednou pomocí tlačítka **Celá série z GG** a jen upravit příznaky, které z databáze získat nejde. To umožňuje snadné opravy a případně změnu rodičovské keše.

Pomocí modrých šipek vedle jména konkrétní keše lze měnit její pořadí v sérii. Tím se keš přesune v seznamu uvedeným směrem. Pořadí keší v sérii je důležité zejména u sekvenčních sérií.

==== Číslování LAB keší v sérii ====

Číslování keší v sérii je odvozeno od GC kódu rodičovské keše. K němu se přidá znak mínus a za něj pořadové číslo LAB keše v sérii. Toto číslo je převedené z desítkové číselné soustavy na třicetišestkovou (znaky 0-9,A-Z). Prozatím se snad se všemi sériemi vejdeme do jednoho znaku, ale plugin počítá i se dvěma znaky. To dává 1295 keší v jedné sérii.

Protože GeoGet musí mít GC kód jako jedinečnou hodnotu v celé databázi, nastává trochu problém v případě, že od jedné keše (typicky megaevent) je odvozeno několik sérií LAB keší. V tomto případě bude použito dvouznakové pořadové číslo, kde bude první znak A-Z a bude použit jako pořadové číslo série přiřazené ke stejné rodičovské keši.

Obecný tvar tedy je:

  <GC_kód_rodičovské_keše>-[<písmeno_série>]<pořadí_v_sérii>
nebo
  <GC_kód_rodičovské_keše>-<dvouznakové_pořadí_v_sérii>

(Písmeno série nemusí mít nutně počátek v A a směřovat k Z, ale může být náhodné nebo i opačně od Z k A.)  
 
Příklady:

  * GCxxxxxx-0 ... první labka v sérii
  * GCxxxxxx-A ... 11. labka v sérii
  * GCxxxxxx-10 ... 37. labka
  * GCxxxxxx-A0 ... 1. labka v první sérii k této rodičovské keši (ale také 361. labka v sérii, kdyby byla jediná velká série)
  * GCxxxxxx-B1 ... 2. labka v druhé sérii k této rodičovské keši

Zůstává tak:

  * jedinečnost kódu keše pro GeoGetí databázi
  * zachován rodičovský kód, z URL se dá odstranit snadno mínus a vše za ním
  * máme možnost odlišit série
  * není problém použit číslování i pro velké série, jen bude třeba si uvědomit, že písmeno v pořadovém čísle není číslem série, ale doplňuje vyčerpanou číselnou řadu s prvním znakem 0-9

===== Známé problémy =====
<WRAP center round important>
K importu do GeoGetu **používejte plugin a ne standardní import GPX souboru** (CTRL+I). Důvody jsou hlavně následující:
</WRAP>

  * v případě změny pořadí LABek v sérii nedojde ke změně nálezu ke správné LABce
  * v případě změny GC kódu rodičovské keše nedojde k odstranění původních LABek z databáze a série tak bude v databázi pod starým i novým GC kódem
  * nebudou odstraněny tagy, které u LABky dříve byly a v aktualizovaném GPX souboru už nejsou. Může se jednat např. o příznak sekvenční série, existence bonusové keše, ... To není chyba GeoGetu, ale vlastnost, která zabraňuje tomu, aby při aktualizaci normální keše byly vymazány uživatelem nastavené tagy. Bohužel v případě sérií LABek to způsobuje problémy, které musí řešit plugin 

<WRAP center round tip>
K importu GPX souborů, pokud je stahujete samostatně, používejte záložku **Různé** a tlačítko **Vybrat a importovat**.
</WRAP>

  * na začátku listingu každé labky je odkaz na LAB sérii. **Pro správnou funkci tohoto odkazu a otevření série v originální aplikaci** je asi nutné HTML odkaz otvírat v Chrome, který otevření přesměruje z browseru na aplikaci. Více podrobností [[http://www.geocaching.cz/topic/32631-novy-server-pro-adventure-lab-a-plugin-pro-gg/?p=592114|v tomto příspěvku]] ve vlákně věnovaném serveru s LABkami 


===== Stažení =====
<WRAP round download>
Stáhnout aktuální verzi: ~~DOWNLOAD labforgg-*.gip highest~~
</WRAP>

==== Seznam dostupných verzí ====
{{filelist>labforgg:*.[gz]ip&style=table&tableheader=1&tableshowdate=1&sort=mtime}}

===== Seznam změn =====
** 2.2.4.81 (7.6.2024) **
  * (19.6.2024) upravena instalace, nyní obsahuje i soubor ''groundspeak.default.pas''
  * načítání nalezených LABek přes API
  * bezpečný import umožňuje importovat více souborů najednou 

** 2.2.4.74 (22.5.2023) **
  * úprava vyhledávání nalezených LABek v HTML souboru uloženém z webu GS
  * řada drobných oprav

** 2.2.4.70 (7.4.2023) **
  * oprava vyhledávání při zadaném GC kódu rodičovské série
  * řada drobných oprav

** 2.2.3.46 (11.3.2022) **
  * oprava přenosu nálezů z parsovaného HTML souboru z webu do GG

** 2.2.3.42 (25.12.2021, počet stažení: 258) **
  * zvýšen maximální počet labek v sérii na 150, aby bylo možné pracovat se sérií Líné labky
  * možnost zobrazit nedokončené série
  * spousta drobných oprav

  
<hidden onHidden=":!: **Zobrazit změny ve starších verzích**" onVisible="Skrýt změny ve starších verzích">
** 2.2.1.7 (20.12.2020) **
  * lépe rozeznává správné pořadí LABek v sérii, tedy méně varování při importu
  
** 2.2.1.5 (16.12.2020, počet stažení: 67) **
  * oprava importu, pokud jméno adresáře obsahuje mezeru
  * nová možnost promítnout při importu příznak sekvenční série a pořadí jednotlivých LABek do D/T
  
** 2.2.1.1 (10.12.2020, počet stažení: 95) **
  * oprava práce s protokolem importu
  * oprava porovnání podle jména LABek v sérii
  
** 2.2.1 (5.12.2020, počet stažení: 87) **
  * zcela přepracovaný import dat
  * další drobné opravy a změny

** 1.3.12 (2.3.2020, počet stažení: 83) **
  * úvodní veřejná verze pluginu

** 2.1.35.1 (18.11.2020, počet stažení: 116) **
  * oprava zapamatování posledního data/času importu sérií

** 2.1.35 (18.11.2020) **
  * oprava kontroly GC kódu LABek při importu
  * změna stahování GPX souborů ze serveru - stahují se všechny najednou jako *.zip
  * v Admin části: do listingu v GPX souboru doplněna informace o počtu LABek v sérii a případně o sekvenční sérii

** 2.1.33 (8.11.2020, počet stažení: 91) **
  * v Admin části: úprava generovaného GPX souboru
  * možnost bezpečného importu GPX souboru získaného jinak než stažením pluginem ze serveru
  * možnost hromadné aktualizace vybraných sérií (na jediný požadavek na server)
  * drobné opravy

** 2.1.31 (12.10.2020, počet stažení: 123) **
  * tvorba souboru s osobními daty pro keškomapu
  * drobné opravy

** 2.1.25 (17.5.2020, počet stažení: 173) **
  * drobné opravy

** 2.1.23 (10.4.2020) **
  * oprava načítání vyhledávacího profilu

** 2.1.20 (19.3.2020, počet stažení: 48) **
  * zásadní přepracování pluginu i webu, rozlišovacím údajem série je jedinečné číslo LabId, od něj je odvozena veškerá manipulace se sériemi
</hidden>

{{tag>author_Gord skript ggp}}