Uitgebreid Zoeken - Revision history

Timb: /* Itemsoorten */

2019-03-20T20:22:01Z

‎Itemsoorten

Timb: /* Itemsoorten */

2019-02-08T12:47:56Z

‎Itemsoorten

Timb: /* Serialisatie */

2019-02-08T12:05:32Z

‎Serialisatie

Timb: Created page with "Category:WebCie In het nieuwe Uitgebreid Zoeken kunnen gebruikers hun eigen kwerries samenstellen door sleuren en pleuren. Dit wordt dan op de server omgezet tot een SQL-..."

2019-02-06T22:00:59Z

Created page with "Category:WebCie In het nieuwe Uitgebreid Zoeken kunnen gebruikers hun eigen kwerries samenstellen door sleuren en pleuren. Dit wordt dan op de server omgezet tot een SQL-..."

New page

[[Category:WebCie]]

In het nieuwe Uitgebreid Zoeken kunnen gebruikers hun eigen kwerries samenstellen door sleuren en pleuren. Dit wordt dan op de server omgezet tot een SQL-query, die op de database uitgevoerd wordt, en waarvoor vervolgens de juiste weergave gekozen wordt. De zoekkwerrie wordt overgestuurd als een JSON-object, als een soort fancy s-expressie.

== Front-end: sleuren en pleuren ==

We gebruiken de Javascriptlibrary [https://github.com/stevendwood/html5-dropzone HTML5 Dropzone], die een fijne wrapper geeft om de sleur-en-pleurfunctionaliteit in HTML5. Je hebt hier een niet al te antieke browser voor nodig dus.
Voor elk soort item die de gebruiker in de query kan doen, maken we een template aan (iets met class "zoek-item"), die de gebruiker kan kopiëren naar gaten (iets met class "zoek-gat") in de query. Deze gaten worden dan gevuld met (maar niet vervangen door) kopietjes van dit item. In dit item mogen ook weer gaten voorkomen, bijvoorbeeld voor de "EN"- en "OF"-operatoren.
Omdat we gaten niet vervangen, hebben we ook replacement-functionaliteit: wil je een item vervangen met een ander item, dan pleur je het nieuwe item over het andere item heen. De eventhandlers van het gat zorgen ervoor dat de vervanging goedgaat.
De hele state van de query wordt in de structuur van de html-elementen opgeslagen, zodat er niets gedesynct wordt. Een nadeel is dat je niet al te veel fancy's kunt doen met de opmaak, want we gaan ervan uit dat de kwerrie eruit ziet als een <code>.zoek-gat</code>-element met als (direct) kind precies 1 <code>.zoek-root</code>-element, met als (direct) kind een aantal <code>.zoek-gat</code>-elementen, etc. In feite is de hele structuur niets meer dan een s-expressie met pretentie.

De notatie die we nu gaan aanhouden: als je een item hebt met een paar (oningevulde) gaten, schrijven we die op als <code>(zoektype ? ? ... ?)</code>, en als er een paar gaten zijn ingevuld, wordt het bijvoorbeeld <code>(en (of (vakid) ?) (niet (actief)))</code>

Op dit moment werkt het verplaatsen van al geplaatste items nog niet heel netjes: bij het pleuren wordt namelijk alleen een nieuw item gemaakt van de wortel van hetgeen wat je sleept. Een kopie van <code>(en (vakid) (actief))</code> ziet er dus uit als <code>(en ? ?)</code>, niet <code>(en (vakid) (actief))</code>.

Om formvelden binnen items te ondersteunen (denk aan "lid sinds <datum>"), kunnen items ook een dict attrs van extra waarden, naast de invulling van gaten, meedragen. In de HTML worden deze weergegeven als attributen van de vorm <code>data-zoek-*</code>, zodat <code>data-zoek-bla</code> overeenkomt met een key <code>bla</code> in de attrs. Je moet in Javascript ervoor zorgen dat deze bij elke update van het formveld dit in de attributen geupdate wordt.

== Serialisatie ==

TODO: documenteer dit

== Itemsoorten ==

TODO: documenteer dit

@@ Line 43: / Line 43: @@
 | niet || 1 || {} || negatie: ('''niet''' ''q'') bestaat uit iedereen die niet in ''q'' zit
 |-
-| lidtoestand || 0 || {'toestand': ...} || lidtoestand komt overeen met <code>attrs.toestand</code>: 'lid': "gewoon" huidig lid of BAL; 'oudlid': vroeger, maar niet meer, lid; 'bijnalid': heeft zich ingeschreven voor de intro maar is nog niet lid geworden; 'bal': Bijzonder Actief Lid (staat bij huidige leden, niet bij oudleden); 'erelid': erelid (staat niet bij huidige leden); 'verdienste': lid van verdienste (staat niet bij huidige leden).
+| lidtoestand || 0 || {'lidtoestand': ...} || lidtoestand komt overeen met <code>attrs.lidtoestand</code>: 'lid': "gewoon" huidig lid of BAL; 'oudlid': vroeger, maar niet meer, lid; 'bijnalid': heeft zich ingeschreven voor de intro maar is nog niet lid geworden; 'bal': Bijzonder Actief Lid (staat bij huidige leden, niet bij oudleden); 'erelid': erelid (staat niet bij huidige leden); 'verdienste': lid van verdienste (staat niet bij huidige leden).
 |-
 | studeert || 0 || {'studie': ...} || doet op dit moment de gegeven studie. <code>attrs.studie</code> is het ID van een Studie-object in de database.

← Older revision		Revision as of 12:47, 8 February 2019
Line 32:		Line 32:
	== Itemsoorten ==		== Itemsoorten ==

−	~~TODO~~: ~~documenteer~~ dit	+	De volgende itemsoorten worden ondersteund:
		+
		+	{\| class="wikitable sortable"
		+	! Zoektype !! Gaten !! Attributen !! Betekenis
		+	\|-
		+	\| en \|\| 2 \|\| {} \|\| conjunctie: ('''en''' ''l'' ''r'') bestaat uit de doorsnede van iedereen in ''l'' en iedereen in ''r''
		+	\|-
		+	\| of \|\| 2 \|\| {} \|\| disjunctie: ('''of''' ''l'' ''r'') bestaat uit de vereniging van iedereen in ''l'' met iedereen in ''r''
		+	\|-
		+	\| niet \|\| 1 \|\| {} \|\| negatie: ('''niet''' ''q'') bestaat uit iedereen die niet in ''q'' zit
		+	\|-
		+	\| lidtoestand \|\| 0 \|\| {'toestand': ...} \|\| lidtoestand komt overeen met <code>attrs.toestand</code>: 'lid': "gewoon" huidig lid of BAL; 'oudlid': vroeger, maar niet meer, lid; 'bijnalid': heeft zich ingeschreven voor de intro maar is nog niet lid geworden; 'bal': Bijzonder Actief Lid (staat bij huidige leden, niet bij oudleden); 'erelid': erelid (staat niet bij huidige leden); 'verdienste': lid van verdienste (staat niet bij huidige leden).
		+	\|-
		+	\| studeert \|\| 0 \|\| {'studie': ...} \|\| doet op dit moment de gegeven studie. <code>attrs.studie</code> is het ID van een Studie-object in de database.
		+	\|-
		+	\| studeerde \|\| 0 \|\| {'studie': ...} \|\| studeerde vroeger, niet meer, de gegeven studie. Zie '''studeert''' voor info over <code>attrs.studie</code>.
		+	\|-
		+	\| studieOnbekend \|\| 0 \|\| {} \|\| geen studiegegevens bekend
		+	\|-
		+	\| vakidPost \|\| 0 \|\| {} \|\| heeft aangegeven de Vakidioot per post te willen ontvangen
		+	\|-
		+	\| aesRoots \|\| 0 \|\| {} \|\| heeft aangegeven de A–Eskwadraat√roots te willen ontvangen
		+	\|-
		+	\| actiefCie \|\| 0 \|\| {} \|\| is actief in een commissie
		+	\|-
		+	\| actiefAlles \|\| 0 \|\| {} \|\| is actief in een commissie, groep of dispuut
		+	\|-
		+	\| actiefRecent \|\| 0 \|\| {} \|\| is, of was afgelopen jaar, actief in een commissie, groep of dispuut
		+	\|-
		+	\| deelnemer \|\| 0 \|\| {} \|\| staat bij de deelnemers voor een activiteit afgelopen jaar
		+	\|-
		+	\| adresBekend \|\| 0 \|\| {} \|\| adres bekend in de database
		+	\|-
		+	\| emailBekend \|\| 0 \|\| {} \|\| email bekend in de database
		+	\|-
		+	\| donateur \|\| 0 \|\| {} \|\| is op dit moment donateur
		+	\|-
		+	\| donateurGeweest \|\| 0 \|\| {} \|\| was donateur maar nu niet meer
		+	\|-
		+	\| afgestudeerd \|\| 0 \|\| {'coljaar': ...} \|\| afgestudeerd in <code>attrs.coljaar</code>. Collegejaren worden gegeven als string van het jaar waarin ze beginnen, dus '2017' is 3 sept 2017 - 3 sept 2018.
		+	\|-
		+	\| almaOK \|\| 0 \|\| {} \|\| willen opgenomen worden in de almanak
		+	\|-
		+	\| geluksvogel \|\| 0 \|\| {} \|\| jonger dan 18 jaar
		+	\|-
		+	\| kart \|\| 0 \|\| {} \|\| zit in de kart van de gebruiker
		+	\|-
		+	\| lidVan \|\| 0 \|\| {'coljaar': ...} \|\| lid geworden in <code>attrs.coljaar</code>. Collegejaren worden gegeven als string van het jaar waarin ze beginnen, dus '2017' is 3 sept 2017 - 3 sept 2018.
		+	\|-
		+	\| lidTot \|\| 0 \|\| {'coljaar': ...} \|\| lid-af in <code>attrs.coljaar</code>. Collegejaren worden gegeven als string van het jaar waarin ze beginnen, dus '2017' is 3 sept 2017 - 3 sept 2018.
		+	\|-
		+	\| voornaamwoord \|\| 0 \|\| {'voornaamwoordID': ...} \|\| gebruikt persoonlijk voornaamwoord met ID <code>attrs.voornaamwoordID</code>.
		+	\|-
		+	\| bounces \|\| 0 \|\| {} \|\| heeft bounces: e-mails die door de site zijn verstuurd maar niet zijn aangekomen
		+	\|}

@@ Line 18: / Line 18: @@
 == Serialisatie ==
-TODO: documenteer dit
+Als de gebruiker vervolgens op de zoekknop drukt, wordt een geserialiseerde kwerrie opgestuurd. Op basis van de HTML wordt een JSON-object gemaakt dat de zoekkwerrie encodeert. Omdat de structuur om en om bestaat uit gat met misschien een item, en item met een lijst gaten, doen we ook twee serialisatiestappen in mutuele recursie. Een gat serialiseert tot ofwel de serialisatie van het item dat erinzit, ofwel <code>null</code>. Een item serialiseert tot een JSON-object van de vorm <code>{'head': ... , 'tail': ... , 'attrs': ...}</code>. De head is het zoektype van dit item (<code>'en'</code> voor de logische conjunctieoperator, <code>'vakid'</code>, etc.), de tail is een lijst van alle (geserialiseerde) gaten van dit item (inclusief <code>null</code> voor oningevulde!), en de attrs zijn een dict met strings, de extra attributen (zoals de waarden van inputs in dit zoekitem).
 == Itemsoorten ==
 TODO: documenteer dit