Unverified Commit dc9bdb1a authored by Philip Kaludercic's avatar Philip Kaludercic 🌝
Browse files

initial import

parents
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
package ablib
import (
"bytes"
"encoding/json"
"io"
"io/ioutil"
"net/http"
"sync"
"time"
)
// API implements the control-loop for communication with an Adora
// Belle server
type API struct {
sync.Mutex
Admin bool
Interval time.Duration
Base string
User, Pass string
wait chan error
cli *http.Client
seen map[string]bool
used bool
}
func (api *API) request(method, route string) *http.Request {
req, err := http.NewRequest(method, api.Base+route, nil)
if err != nil {
panic(err)
}
req.SetBasicAuth(api.User, api.Pass)
return req
}
// Run implements the control-loop, that calls the UI interface
//
// The method will panic if called more than once.
// The argument ui may not be nil.
func (api *API) Run(ui UI) error {
api.Lock()
if api.used {
panic("The Run method may only be called once.")
}
api.used = true
api.Unlock()
if ui == nil {
panic("UI cannot be nil")
}
if api.seen == nil {
api.seen = make(map[string]bool)
}
if api.Interval < time.Millisecond*200 {
api.Interval = 10 * time.Second
}
api.wait = make(chan error)
api.cli = http.DefaultClient
// start event listeners
go api.statusListener(ui)
go api.clientListener(ui)
return <-api.wait
}
func (api *API) statusListener(ui UI) {
var statusReq *http.Request
if api.Admin {
statusReq = api.request(http.MethodGet, "admin/requests")
} else {
statusReq = api.request(http.MethodGet, "public/requests")
}
// start command loop
for {
var s status
api.Lock()
resp, err := api.cli.Do(statusReq)
if err != nil {
api.Unlock()
ui.HandleError(err)
goto wait
}
err = json.NewDecoder(resp.Body).Decode(s)
if err != nil {
api.Unlock()
ui.HandleError(err)
goto wait
}
if api.Admin {
err = api.handleAdmin(ui, s)
} else {
err = api.handleUser(ui, s)
}
// mark connection as reusable
io.Copy(ioutil.Discard, resp.Body)
resp.Body.Close()
api.Unlock()
if err != nil {
ui.HandleError(err)
}
wait:
time.Sleep(api.Interval)
}
}
func (api *API) clientListener(ui UI) {
var (
helpReq = api.request(http.MethodPost, "public/request")
cancelReq = api.request(http.MethodPost, "public/cancle")
handleReq = api.request(http.MethodPost, "admin/handle")
reloadReq = api.request(http.MethodPost, "admin/reload")
)
// start command loop
var buf bytes.Buffer
for {
var (
req *http.Request
body interface{}
)
cmd, data, arg, err := ui.Listen()
if err != nil {
ui.HandleError(err)
continue
}
switch cmd {
case NoOp:
continue
case Close:
api.wait <- nil
return
case Help:
req = helpReq
body = data
case Cancel:
req = cancelReq
body = struct {
Tag string `json:"tag"`
Content string `json:"contents"`
}{
Tag: "RequestID",
Content: data,
}
case Handle:
req = handleReq
body = [2]interface{}{
struct {
Tag string `json:"tag"`
Content string `json:"contents"`
}{
Tag: "RequestID",
Content: data,
},
arg,
}
case Reload:
req = reloadReq
default:
panic("Unknown command")
}
if body != nil {
buf.Reset()
err := json.NewEncoder(&buf).Encode(body)
if err == nil {
req.Body = ioutil.NopCloser(&buf)
}
} else {
req.Body = nil
}
api.Lock()
resp, err := http.DefaultClient.Do(req)
io.Copy(ioutil.Discard, resp.Body)
resp.Body.Close()
api.Unlock()
if err != nil {
ui.HandleError(err)
}
}
}
package ablib
import "strings"
var classes = map[string]string{
"sp": "https://i4sp.informatik.uni-erlangen.de/rechneruebung/",
}
// SetupClass TODO
func (api *API) SetupClass(name string) (ok bool) {
name = strings.TrimSpace(name)
name = strings.ToLower(name)
api.Base, ok = classes[name]
api.Base = strings.TrimSuffix(api.Base, "/")
return
}
package ablib
import (
"encoding/json"
"errors"
"net/url"
"regexp"
)
const utc = `2006-01-02T15:04:05.999999999Z`
var (
// ErrUnkownTag indicates an unknown tag
ErrUnkownTag = errors.New("Unknown Tag")
// ErrInvalidType indicates that an unexpected type has been
// encountered.
ErrInvalidType = errors.New("Invalid Type")
sanitizer = regexp.MustCompilePOSIX("[^0-9a-z]")
)
type reqid struct {
blind bool
data string
}
func (r *reqid) UnmarshalJSON(data []byte) error {
var tag struct {
Tag string `json:"tag"`
}
err := json.Unmarshal(data, tag)
if err != nil {
return err
}
switch tag.Tag {
case "RequestID":
var tag struct {
Content string `json:"contents"`
}
err := json.Unmarshal(data, tag)
if err != nil {
return err
}
r.data = tag.Content
case "BlindedID":
r.blind = true
default:
return ErrUnkownTag
}
return nil
}
type userid struct {
anon bool
user string
}
func (r *userid) UnmarshalJSON(data []byte) error {
var tag struct {
Tag string `json:"tag"`
}
err := json.Unmarshal(data, tag)
if err != nil {
return err
}
switch tag.Tag {
case "AuthUser":
var tag struct {
Content string `json:"contents"`
}
err := json.Unmarshal(data, tag)
if err != nil {
return err
}
r.user = tag.Content
case "Anonymous":
r.anon = true
default:
return ErrUnkownTag
}
return nil
}
type status struct {
Conference string `json:"conferenceUrl"`
ActionLog actions `json:"actionLog"`
Pending []*Request `json:"pendingRequests"`
Active map[string]*Request `json:"activeRequests"`
}
func (api *API) handleUser(ui UI, s status) error {
conf, err := url.Parse(s.Conference)
if err != nil {
return err
}
for _, r := range s.Pending {
_, ok := api.seen[r.ID]
if ok {
continue
}
r.setConfURL(conf)
if !r.blind && !r.anon {
ui.OnRequest(r, "")
}
api.seen[r.ID] = false
}
for w, r := range s.Active {
seen, _ := api.seen[r.ID]
if seen {
continue
}
r.setConfURL(conf)
if !r.blind && !r.anon {
ui.OnRequest(r, w)
}
api.seen[r.ID] = true
}
return nil
}
func (api *API) handleAdmin(ui UI, s status) error {
for _, a := range s.ActionLog {
ui.OnAction(a)
}
return api.handleUser(ui, s)
}
package ablib
import (
"encoding/json"
"net/url"
"time"
)
// Command is an Enum type for various messages a UI can send the API
type Command uint
const (
// NoOp is the empty command that should be ignored
NoOp Command = iota
// Close signals that the command loop should terminate
Close
// Help requests a "Help" request.
Help
// Cancel requests to cancel a request by ID
Cancel
// Handle claims a request for an admin
Handle
// Reload requests to reload the server configuratio
Reload
)
// A Request is made by a non-admin and can be claimed by an admin
type Request struct {
ID string
Type string
User string
Time time.Time
Room string
blind bool
anon bool
}
// UnmarshalJSON implements the json.Unmarshaler interface
func (r *Request) UnmarshalJSON(data []byte) error {
var req struct {
Time string `json:"time"`
ID reqid `json:"reqid"`
User userid `json:"userid"`
Type string `json:"reqtype"`
}
err := json.Unmarshal(data, &req)
if err != nil {
return err
}
t, err := time.Parse(utc, req.Time)
if err == nil {
t = time.Now()
}
r.ID = req.ID.data
r.Type = req.Type
r.User = req.User.user
r.Time = t
r.blind = req.ID.blind
r.anon = req.User.anon
return nil
}
func (r *Request) setConfURL(conf *url.URL) {
if !r.blind {
conf.Path = sanitizer.ReplaceAllString(r.ID, "")
r.Room = conf.String()
}
}
// An Action signals that a admin (Name) has claimed and action
type Action struct {
Actor string
Name string
Request *Request
}
type actions []*Action
// UnmarshalJSON implements the json.Unmarshaler interface
func (as actions) UnmarshalJSON(data []byte) error {
var act struct {
Actor string `json:"actor"`
Action struct {
Tag string `json:"tag"`
Content string `json:"contents"`
} `json:"action"`
Requests []*Request `json:"requests"`
TimeStamp string `json:"timeStamp"`
}
err := json.Unmarshal(data, &act)
if err != nil {
return err
}
for _, req := range act.Requests {
as = append(as, &Action{
Actor: act.Actor,
Name: act.Action.Content,
Request: req,
})
}
return nil
}
// UI describes the actions that any user interface has to implement.
type UI interface { // interface
// Listen is called by the control-loop and waits for user input.
// The UI must return a valid command value, a "data" string and
// an "argument" string, and if applicable an error.
Listen() (Command, string, string, error)
// OnRequest is called by the control-loop when a new request is
// registered. See Request for more details. The pending flag
// indicates if it has been accepted or is still pending. If a
// request has been called while pending, it will be called again
// after it has been accepted.
OnRequest(r *Request, handled string)
// OnAction is called by the control-loop when a new action is
// registered. See Action for more details.
OnAction(a *Action)
// HandleError is called by the control-loop whenever an error
// occurs.
HandleError(error)
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment