85 | {% endblock %}
--------------------------------------------------------------------------------
/BusTrack/models/Kid.py:
--------------------------------------------------------------------------------
1 | from BusTrack import db, conn
2 |
3 |
4 | class Kid():
5 | __TABLE__ = 'kid'
6 |
7 | def __init__(self, name=None, section=None, photo=None, parent_id=None, bus_id=None, id=None):
8 | self.id = id
9 | self.name = name
10 | self.section = section
11 | self.photo = photo
12 | self.p_id = parent_id # parent id
13 | self.b_id = bus_id
14 |
15 | def get_all(self):
16 | cur = conn.execute('select * from kid')
17 | return cur.fetchall()
18 |
19 | def add_if_not_exist(self):
20 | cur = conn.execute('select * from kid')
21 |
22 | def add(self):
23 | try:
24 | cur = conn.execute('insert into kid (name,section,photo,p_id,b_id) values(?,?,?,?,?)',
25 | (self.name, self.section, self.photo, self.p_id, self.b_id))
26 | conn.commit()
27 | except:
28 | return None
29 | return cur.lastrowid
30 |
31 | # get kids of particular parent
32 | @staticmethod
33 | def get_kids(parent_id):
34 | cur = conn.execute('select * from kid where p_id=?', (parent_id))
35 | return cur.fetchall()
36 |
37 | # ---------------------code used in driver module-----------------------#
38 | # here j_id is known
39 | # get kids who whose attendance is not yet taken for this bus journey
40 | @staticmethod
41 | def get_kid_ids(journey_id):
42 | cur = conn.execute('select kid.id from kid where kid.id not in( \
43 | select kid.id from attendance inner join kid on attendance.k_id=kid.id \
44 | where j_id=?) and kid.b_id=(select journey.b_id from journey where journey.id=?)',
45 | [journey_id, journey_id])
46 | return Kid.id_to_list(cur.fetchall())
47 |
48 | # get kid ids whose dropped present is not yet taken
49 | @staticmethod
50 | def get_kid_drop_not_present(journey_id):
51 | cur = conn.execute('select attendance.k_id from attendance where j_id=? and pick_present=1 \
52 | and drop_present=0 ', [journey_id])
53 | return Kid.id_to_list(cur.fetchall())
54 |
55 | @staticmethod
56 | def id_to_list(cur):
57 | if cur is None:
58 | return []
59 | else:
60 | return [i[0] for i in cur]
61 |
62 | # get image link of this kid ,only those image for which this driver is authorized
63 | @staticmethod
64 | def get_image_for_driver(token, kid_id):
65 | cur = conn.execute('select kid.photo from kid where kid.b_id=(select driver.b_id from driver where token=? \
66 | ) and kid.id=?', [token, kid_id])
67 | r = cur.fetchone()
68 | if r is None:
69 | return r
70 | else:
71 | return r[0]
72 |
73 | # get image link of this kid ,only those image for which this parent is authorized
74 | @staticmethod
75 | def get_image_for_parent(token,kid_id):
76 | cur=conn.execute('select kid.photo from kid inner join parent on kid.p_id=parent.id \
77 | where parent.token=? and kid.id=? ',[token,kid_id])
78 | r = cur.fetchone()
79 | if r is None:
80 | return r
81 | else:
82 | return r[0]
83 |
84 | # ---------------------driver module ends------------------------#
85 | # -------------------- code for parent module--------------------#
86 |
87 |
--------------------------------------------------------------------------------
/BusTrack/templates/admin/driver.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% extends "layout.html" %}
4 | {% block content %}
5 | {# a macro to show fields error #}
6 | {% macro show_error(input_name) %}
7 | {% if input_name in form.errors %}
8 |
12 |
13 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 | | UserId |
76 | Name |
77 | Bus Allocated |
78 | Contact |
79 |
80 |
81 |
82 | {% for l in driver_list %}
83 |
84 | | {{l[0]}} |
85 | {{l[1]}} |
86 | {{l[2]}} |
87 | {{l[3]}} |
88 |
89 | {% endfor %}
90 |
91 |
92 |
93 |
94 | {% endblock %}
--------------------------------------------------------------------------------
/BusTrack/templates/layout.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
Major-Project School bus tracking system Backend Python
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
61 |
62 |
63 |
64 |
65 |
66 |
67 | School Bus Tracking System {{admin}}
68 |
69 |
70 |
71 |
72 |
73 | {% block content%}
74 |
75 | {% endblock %}
76 |
77 |
78 |
79 |
80 | Developed by Rajat Sahu.
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
--------------------------------------------------------------------------------
/BusTrack/models/driver.py:
--------------------------------------------------------------------------------
1 | from BusTrack import db, conn
2 | from BusTrack.helpers import dbHelpers
3 | from BusTrack.helpers import utils
4 |
5 |
6 | # code for 'driver' table
7 | class Driver():
8 | def __init__(self, user_id=None, name=None, contact=None, password=None, bus_id=None):
9 | self.name = name
10 | self.contact = contact
11 | self.password = password
12 | self.b_id = bus_id
13 | self.userid = user_id
14 |
15 | def add(self):
16 | cur = conn.execute('insert into driver (name,contact,password,b_id,userid) values (?,?,?,?,?)'
17 | , [self.name, self.contact, self.password, self.b_id, self.userid])
18 | print([self.name, self.contact, self.password, self.b_id, self.userid])
19 | conn.commit()
20 | return cur.lastrowid
21 |
22 | def get_all(self):
23 | cur = conn.execute('select * from driver')
24 | return cur.fetchall()
25 |
26 | @staticmethod
27 | def get_user(userid): # check password
28 | cur = conn.execute(
29 | 'select driver.name,driver.password,bus.b_no,driver.active_ride_j_id, bus.id from driver inner join Bus '
30 | 'on driver.b_id=bus.id where driver.userid=? ', [userid])
31 | user = cur.fetchone()
32 | if user is None:
33 | return False
34 | else:
35 | return user # {1:"pass","3":"active ride","4":"bus_id"}
36 |
37 | @staticmethod
38 | def update_token(token, expires, userid):
39 | cur = conn.execute('update driver set token=?,expires=? where userid=?', [token, expires, userid])
40 | conn.commit()
41 |
42 | @staticmethod
43 | def is_unique(user_id):
44 | # method used in Validation unique entity
45 | # check weather given 'user_id' already exist in Driver table
46 | cur = conn.execute('select * from driver where userid=? ', [user_id]) # pass sequence
47 | return dbHelpers.row_zero(cur)
48 |
49 | @staticmethod
50 | def get_all_allocated():
51 | # registered driver who are assigned a bus
52 | cur = conn.execute('select userid,name, b_no,contact from bus_driver')
53 | return cur.fetchall()
54 |
55 | # check if this token is allocated to any driver and is still valid
56 | @staticmethod
57 | def is_valid_token(token):
58 | date = utils.get_date_full()
59 | cur = conn.execute('select userid from driver where token=? and DATETIME(expires) > DATETIME(?)', (token, date))
60 | user = cur.fetchone()
61 | if user is None:
62 | return False
63 | else:
64 | return True
65 |
66 | # get current active ride detail ,else return None
67 | @staticmethod
68 | def get_active_ride(token):
69 | cur = conn.execute('select active_ride_j_id from driver where token=?', [token])
70 | j_id = cur.fetchone()
71 | if j_id is None:
72 | return None
73 | else:
74 | return j_id[0]
75 |
76 | # check if driver has already completed @j_type ride for @date
77 | @staticmethod
78 | def is_ride_already_completed(userid, j_type, date=utils.get_date_only()):
79 | cur = conn.execute('select * from journey inner join bus on bus.id=journey.b_id inner join driver'
80 | ' on driver.b_id=bus.id where driver.userid=? '
81 | ' and date(journey.date)=date(?) and journey.j_type=? and journey.end is not 0 ', [userid, date, j_type])
82 | res = cur.fetchone()
83 | if res is None:
84 | return False # no ride yet
85 | else:
86 | return True
87 |
88 | @staticmethod
89 | def logout_session(token):
90 | # set end journey time
91 | # set token,expiry and active_b_id to null
92 | cur = conn.cursor()
93 | cur.execute('begin')
94 | cur.execute('update journey set end=? where id=(select active_ride_j_id from driver where token=?)',
95 | (utils.get_date_full(), token))
96 | cur.execute("update driver set active_ride_j_id=?,token=?,expires=? WHERE token=?", ('', '', '', token))
97 | cur.execute('commit')
98 |
--------------------------------------------------------------------------------
/BusTrack/models/Parent.py:
--------------------------------------------------------------------------------
1 | from BusTrack import conn
2 | from BusTrack.helpers import utils
3 |
4 |
5 | class Parent():
6 | __TABLE__ = 'parent'
7 |
8 | def __init__(self, name=None, password=None, email=None, phone=None, home_gps=None):
9 | self.name = name
10 | self.password = password
11 | self.email = email
12 | self.phone = phone
13 | self.home_gps = home_gps
14 |
15 | def get_all(self):
16 | cur = conn.execute('select * from parent')
17 | return cur.fetchall()
18 |
19 | def add(self):
20 | cur = conn.execute('insert into parent (name,password,email,phone,home_gps) values(?,?,?,?,?)',
21 | (self.name, self.password, self.email, self.phone, self.home_gps))
22 | conn.commit()
23 | return cur.lastrowid
24 |
25 | def add_or_get(self):
26 | # refer link:admin.kid
27 | cur = conn.execute('select id from parent where email=? ', [self.email])
28 | res = cur.fetchone()
29 | print(res)
30 | if res is None:
31 | # create new record
32 | res = self.add()
33 | return res
34 | else:
35 | return res[0]
36 |
37 | # get user having email =?
38 | @staticmethod
39 | def get_user(email):
40 | cur = conn.execute('select * from parent where email=?', [email])
41 | if cur.rowcount == 0:
42 | return False
43 | else:
44 | return cur.fetchone()
45 |
46 | @staticmethod
47 | def get_all_parent_with_kid():
48 | # get data from parent_kid view
49 | cur = conn.execute('select * from parent_kid')
50 | print(cur.description)
51 | return cur.fetchall()
52 |
53 | @staticmethod
54 | def get_all_parent_kid_with_bus():
55 | # get data from parent_kid_bus view
56 | cur = conn.execute('select * from parent_kid_bus')
57 | print(cur.description)
58 | return cur.fetchall()
59 |
60 | # -------------- code used in Parent Module--------------#
61 |
62 | # get parent from token
63 | @staticmethod
64 | def get_parent_id(token):
65 | cur = conn.execute('select * from parent where token=? ', [token])
66 | return cur.fetchone()
67 |
68 | @staticmethod
69 | def update_token(email, token, expire):
70 | cur = conn.execute('update parent set token=?,expires=? where email=?',
71 | [token, expire, email])
72 | conn.commit()
73 |
74 | # check if this token is allocated to any driver and is still valid
75 |
76 | @staticmethod
77 | def is_valid_token(token):
78 | date = utils.get_date_full()
79 | cur = conn.execute('select email from parent where token=? and DATETIME(expires) > DATETIME(?)', (token, date))
80 | user = cur.fetchone()
81 | if user is None:
82 | return False
83 | else:
84 | return True
85 |
86 | # check weather @param#k_id belongs to parent having token @param#token
87 | @staticmethod
88 | def is_kidOf(kid_id, token):
89 | cur = conn.execute('select kid.id from kid inner join parent on kid.p_id=parent.id '
90 | 'where kid.id=? and parent.token=? ', [kid_id, token])
91 | res = cur.fetchone()
92 | if res is None:
93 | return False
94 | else:
95 | return True
96 |
97 | @staticmethod
98 | def get_kids(token):
99 | cur = conn.execute('select kid.id,name,section,photo,bus.id,bus.b_no from kid inner join bus on kid.b_id=bus.id where kid.p_id = \
100 | (select parent.id from parent where parent.token=? )', [token])
101 | return Parent.kids_to_obj_list(cur.fetchall())
102 |
103 | @staticmethod
104 | def kids_to_obj_list(cur):
105 | if cur is None:
106 | return None
107 | l = []
108 | for c in cur:
109 | k = {"id": c[0], "name": c[1], "section": c[2], "photo": c[3]}
110 | b = {"bus_id": c[4], "bus_name": c[5]}
111 | k_b = {"kid": k, "bus": b}
112 | l.append(k_b)
113 | return l
114 |
--------------------------------------------------------------------------------
/BusTrack/models/attendance.py:
--------------------------------------------------------------------------------
1 | from .. import conn
2 | from BusTrack.models.Kid import Kid
3 |
4 |
5 | class Attendance():
6 | __TABLE__ = 'attendance'
7 |
8 | def __init__(self, pick_present=0, drop_present=0, kid_id=None, journey_id=None, pick_gps=None, drop_gps=None,
9 | pick_time=None, drop_time=None):
10 | # hold attendance for a kid for particular date
11 | self.k_id = kid_id
12 | # journey id
13 | self.j_id = journey_id
14 | # was kid present during picking
15 | self.pick_present = pick_present
16 | # was kid present during drop
17 | self.drop_present = drop_present
18 | self.pick_gps = pick_gps
19 | self.drop_gps = drop_gps
20 | self.pick_time = pick_time
21 | self.drop_time = drop_time
22 |
23 | def add(self):
24 | if self.k_id == None or self.j_id == None:
25 | assert 'Must provide kid and journey id'
26 | else:
27 | cur = conn.execute('insert into attendance (k_id,j_id,pick_present,drop_present,\
28 | pick_gps,drop_gps,pick_time,drop_time) \
29 | values(?,?,?,?,?,?,?,?)',
30 | (self.k_id, self.j_id, self.pick_present, self.drop_present,
31 | self.pick_gps, self.drop_gps, self.pick_time, self.drop_time))
32 | conn.commit()
33 | return cur.lastrowid
34 |
35 | #--------for pick up time in journey
36 | # return kids whose attendance is taken by driver for this journey
37 | @staticmethod
38 | def get_kid_attended(driver_token):
39 | cur = conn.execute('select * from kid where kid.id in ( \
40 | select attendance.k_id from attendance where attendance.j_id=( \
41 | select driver.active_ride_j_id from driver where driver.token=? )) order by lower(kid.name) asc ', [driver_token])
42 |
43 | return Attendance.to_kid_list(cur.fetchall())
44 |
45 | # return kids whose attendance is not yet taken
46 | @staticmethod
47 | def get_kid_not_attended(driver_token):
48 | cur = conn.execute('select * from kid where kid.id not in ( \
49 | select attendance.k_id from attendance where attendance.j_id=( \
50 | select driver.active_ride_j_id from driver where driver.token=? )) \
51 | and kid.b_id=(select driver.b_id from driver where driver.token=? ) order by lower(kid.name) asc', [driver_token,driver_token])
52 | return Attendance.to_kid_list(cur.fetchall())
53 |
54 | # ---------for drop time in journey
55 | #-----if the kid is picked but not yet dropped
56 | @staticmethod
57 | def get_kid_not_dropped(driver_token):
58 | cur=conn.execute('select * from kid where kid.id in ( \
59 | select attendance.k_id from attendance where attendance.j_id=( \
60 | select driver.active_ride_j_id from driver where driver.token=? )\
61 | and attendance.drop_present=0 ) order by lower(kid.name) asc',[driver_token])
62 | return Attendance.to_kid_list(cur.fetchall())
63 |
64 | #-----get list of kid who is picked and also dropped
65 | @staticmethod
66 | def get_kid_dropped(driver_token):
67 | cur=conn.execute('select * from kid where kid.id in ( \
68 | select attendance.k_id from attendance where attendance.j_id=( \
69 | select driver.active_ride_j_id from driver where driver.token=? )\
70 | and attendance.drop_present=1 ) order by lower(kid.name) asc ',[driver_token])
71 | return Attendance.to_kid_list(cur.fetchall())
72 |
73 | @staticmethod
74 | def to_kid_list(cursor):
75 | if cursor is None:
76 | return None
77 | kids = []
78 | for c in cursor:
79 | id = c[0]
80 | name = c[1]
81 | section = c[2]
82 | photo = c[3]
83 | kid = Kid(id=id, name=name, section=section, photo=photo)
84 | kids.append(kid)
85 | return kids
86 |
87 | # set dropped =1 to attendance table
88 | @staticmethod
89 | def update_drop_attendance(kid_id,drop_gps,drop_time,journey_id):
90 | cur=conn.execute('update attendance set drop_present=1,drop_gps=?,drop_time=? \
91 | where k_id=? and j_id=? ',[drop_gps,drop_time,kid_id,journey_id])
92 | conn.commit()
93 |
94 |
--------------------------------------------------------------------------------
/BusTrack/views/admin.py:
--------------------------------------------------------------------------------
1 | from flask import Blueprint, render_template, jsonify, redirect, url_for, request, flash
2 | from flask import session
3 | from functools import wraps
4 | from BusTrack.helpers import SessionHelper, utils
5 | from BusTrack.forms.adminforms import UserPasswordForm, AddDriverForm, AddKidForm
6 | from BusTrack.models.driver import Driver
7 | from BusTrack.models.bus import Bus
8 | from BusTrack.models.Kid import Kid
9 | from BusTrack.models.Parent import Parent
10 | from BusTrack.models.feedback import Feedback
11 |
12 | admin = Blueprint('admin', __name__)
13 |
14 |
15 | # custom decorator to handle access
16 | def login_required(f):
17 | @wraps(f)
18 | def decorated_function(*args, **kwargs):
19 | if 'is_admin_login' in session:
20 | if session['is_admin_login'] == True:
21 | pass # ok no problem
22 | else:
23 | return redirect(url_for('admin.login', next=request.url))
24 | else:
25 | return redirect(url_for('admin.login', next=request.url))
26 | return f(*args, **kwargs)
27 |
28 | return decorated_function
29 |
30 |
31 | @admin.route('/')
32 | def root():
33 | return render_template('admin/index.html')
34 |
35 |
36 | @admin.route('/index')
37 | def index():
38 | return render_template('admin/index.html')
39 |
40 |
41 | @admin.route('/login', methods=['GET', 'POST'])
42 | def login():
43 | form = UserPasswordForm(request.form)
44 | if form.validate_on_submit() and request.method == 'POST':
45 | # check password and redirect to admin home
46 | from BusTrack import app
47 | if app.config['ADMIN_USERNAME'] == form.username.data and \
48 | SessionHelper.is_password_correct(app.config['ADMIN_PASSWORD'], form.password.data):
49 | session['is_admin_login'] = True
50 | return redirect(request.args.get('next') or url_for('admin.index'))
51 | else:
52 | flash('incorrect credentials')
53 | render_template('admin/login.html', form=form)
54 |
55 | return render_template('admin/login.html', form=form)
56 |
57 |
58 | @admin.route('/driver', methods=['POST', 'GET'])
59 | @login_required
60 | def driver():
61 | # handle driver tasks
62 | form = AddDriverForm(request.form)
63 | # TODO : Disable add when no bus unallocated (for now using front-end logic)
64 | un_alloc = Bus.unallocated_bus()
65 | if form.validate_on_submit() and request.method == 'POST':
66 | # if 'bus' not in request.form:
67 |
68 | # TODO: later add option for update
69 | d = Driver(user_id=form.username.data, bus_id=request.form['bus']
70 | , name=form.name.data, contact=form.contact.data,
71 | password=SessionHelper.get_password_hash(form.password.data))
72 | d.add()
73 | # clear fileds
74 | form.username.data = form.name.data = form.contact.data = ''
75 | # return render_template('admin/driver.html',form=form)
76 | alloc_driver = Driver.get_all_allocated()
77 | return render_template('admin/driver.html', form=form, bus_data=un_alloc, driver_list=alloc_driver)
78 |
79 |
80 | @admin.route('/kid', methods=['GET', 'POST'])
81 | @login_required
82 | def kid():
83 | form = AddKidForm(request.form)
84 |
85 | if form.validate_on_submit() and request.method == 'POST':
86 | if 'bus' in request.form:
87 | rand_pass = utils.rand(6)
88 | # store parent and get its unique id to store it in Kid table
89 | # BUT BUT ,if parent already register then don't re-register instead add this kid to previously added parent
90 | p = Parent(name=form.parent_name.data, password=rand_pass, email=form.email.data)
91 | p_id = p.add_or_get()
92 | k = Kid(name=form.kid_name.data, section=form.kid_section.data, bus_id=request.form['bus'], parent_id=p_id)
93 | from sqlite3 import IntegrityError
94 | k.add()
95 | # clear form field
96 | form.parent_name.data = form.email.data = form.kid_name.data = form.kid_section.data = form.parent_name.data = ''
97 | # TODO: Send this generated password to Parent email
98 |
99 | else:
100 | all_parent_kid = Parent.get_all_parent_kid_with_bus()
101 | all_bus = Bus().get_all()
102 | return render_template('admin/kid.html', form=form, bus_data=all_bus, bus_error='Must Select a Bus',
103 | all_parent_kid=all_parent_kid)
104 | all_parent_kid = Parent.get_all_parent_kid_with_bus()
105 | all_bus = Bus().get_all()
106 | return render_template('admin/kid.html', form=form, bus_data=all_bus, all_parent_kid=all_parent_kid)
107 |
108 |
109 | @admin.route('/feedback', methods=['GET', 'POST'])
110 | @login_required
111 | def feedback():
112 | feed = Feedback().get_all()
113 | return render_template('admin/feeds.html', feed_list=feed)
114 |
115 |
116 | @admin.route('/track', methods=['GET', 'POST'])
117 | @login_required
118 | def show_map():
119 | if request.method == 'GET':
120 | print("get method")
121 | elif request.method == 'POST':
122 | print("post method")
123 | return render_template('/admin/track.html')
124 |
125 |
126 | @admin.route('/api/reply_email', methods=['POST'])
127 | @login_required
128 | def reply_email():
129 | # get data as post
130 | if 'msg_id' in request.form and 'email' in request.form and 'title' in request.form and 'message' in request.form:
131 | # TODO send email using smtp api
132 | return jsonify(success='ok', message='message sent')
133 | else:
134 | return jsonify(success='error', message='insufficient parameters')
135 |
136 |
137 | @admin.route('/logout')
138 | def logout():
139 | session.pop('is_admin_login', None)
140 | return redirect(url_for('admin.login'))
141 |
--------------------------------------------------------------------------------
/BusTrack/models/Rides.py:
--------------------------------------------------------------------------------
1 | from BusTrack.helpers import utils
2 | from BusTrack.models.Parent import Parent
3 | from BusTrack import conn
4 |
5 |
6 | # a special file to handle Rides related stuff
7 | # fetch ride of all kids of a parent
8 | # parent token require
9 | class ActiveRide():
10 | def __init__(self, token, date=utils.get_date_only()):
11 | if token is None or token is '':
12 | raise ValueError('invalid token') # error 403
13 | self.token = token
14 | self.date = date # default today if not provided
15 | self.is_active = True
16 |
17 | # get active ride for each kid
18 | def get_active_ride(self):
19 | kids = Parent.get_kids(self.token) # may be None
20 | if kids is None:
21 | raise ValueError('invalid token') # error 403
22 |
23 | rides = []
24 | for kid_bus in kids:
25 | kid = kid_bus['kid']
26 | res = self.__sql__(kid['id'])
27 | if res is not None:
28 | rides.append({"kid": kid, "journey_id": res[0], "journey_type": res[1], "current_gps": res[2],
29 | "start_time": res[3], "start_gps": res[4]})
30 | return rides
31 |
32 | # return single kid status , weather today's ride is completed or active
33 | def get_single_status(self, kid_id):
34 | res = self.__sql__(kid_id)
35 | if res is None:
36 | return 'no active ride' # no active
37 | else:
38 | return 'ride is active ' # yes active
39 |
40 |
41 | def __sql__(self, kid_id):
42 | cur = conn.execute('select journey.id,journey.j_type ,journey.gps,attendance.pick_time,\
43 | attendance.pick_gps from attendance inner join journey on attendance.j_id=journey.id \
44 | where date(attendance.pick_time)=date(?) and attendance.k_id=? \
45 | and attendance.drop_present=0 limit 1 ', [self.date, kid_id])
46 | return cur.fetchone()
47 |
48 |
49 | # get all recent rides associated to this kid
50 | def get_recent_rides(self, kid_id):
51 | cur = conn.execute('select journey.id,journey.j_type ,attendance.pick_time,'
52 | 'attendance.pick_gps ,attendance.drop_time,attendance.drop_gps,attendance.drop_present , journey.gps '
53 | 'from attendance inner join journey on attendance.j_id=journey.id '
54 | 'where attendance.k_id=? order by attendance.id desc limit 50 ', [kid_id])
55 | res = cur.fetchall()
56 | if res is None:
57 | return []
58 | else:
59 | l = []
60 | for r in res:
61 | l.append(
62 | {"journey_id": r[0], "journey_type": r[1], "start_time": r[2], "start_gps": r[3], "end_time": r[4],
63 | "end_gps": r[5], "completed": r[6],"current_gps":r[7]})
64 | return l
65 |
66 |
67 | # a special class to handle bus status
68 | # check the bus current location if it is to be arrived kid's home
69 | # scenario:
70 | # * Bus driver login to app when driver to pick student from their home to school
71 | # * SO here journey_type=0 (from home to school)
72 | # * now check in attendance table weather kid is already picked up, if not then
73 | # * show bus status as arriving (send current location and distance)
74 |
75 | class BusArriving():
76 | def __init__(self, token):
77 | self.token = token
78 | if token is None or token is '':
79 | raise ValueError('Invalid Token')
80 |
81 | # return a str message about bus arriving status
82 | def arriving_buses(self):
83 | kids = Parent.get_kids(self.token)
84 | # iterate for each kid
85 | arr = []
86 | for k in kids:
87 | k_id = k['kid']['id']
88 | b_id = k['bus']['bus_id']
89 | res = self.__get_journey__(k_id, b_id)
90 | if res is not None:
91 | res['name'] = k['kid']['name']
92 | arr.append(res)
93 | return arr
94 |
95 | # gets journey detail of arriving bus , for this bus on active ride
96 | def __get_journey__(self, kid_id, bus_id):
97 | cur = conn.execute(
98 | 'select journey.id,journey.gps,journey.last_update from journey inner join driver on '
99 | 'journey.id=driver.active_ride_j_id '
100 | ' where driver.b_id=? and j_type=0 ',
101 | [bus_id])
102 | res = cur.fetchone()
103 | if res is None:
104 | # no journey exist
105 | return None
106 | else:
107 | cur = conn.execute('select id from attendance where k_id=? and j_id=? ', [kid_id, res[0]])
108 | res_2 = cur.fetchone()
109 | # if exist NO record, it means kid is still waiting for bus
110 | if res_2 is None:
111 | return {"id": res[0], "current_gps": res[1], "last_update": res[2], "bus_id": bus_id, "kid_id": kid_id}
112 | else:
113 | # kids journey is already started
114 | return None
115 |
116 | # check if bus is arriving for this kid
117 | def arriving_for_kid(self, kid_id, bus_id):
118 | res = self.__get_journey__(kid_id, bus_id)
119 | if res is None:
120 | return False
121 | else:
122 | return res
123 |
124 |
125 | class Track:
126 | def __init__(self, p_token, kid_id):
127 | self.token = p_token
128 | self.kid_id = kid_id
129 |
130 | # get current location of bus
131 | def get_latest_location(self):
132 | cur = conn.execute('select journey.gps,journey.last_update from journey where journey.id= ( '
133 | 'select driver.active_ride_j_id from driver inner join kid on kid.b_id=driver.b_id '
134 | 'inner join parent on parent.id=kid.p_id where parent.token=? and kid.id=? ) and '
135 | 'journey.end=0',
136 | [self.token, self.kid_id])
137 | return cur.fetchone()
138 |
139 | # get all location in this journey
140 | def get_all_locations(self):
141 | cur = conn.execute('select location.id,location.gps,location.time from location where location.j_id= ( '
142 | ' select driver.active_ride_j_id from driver inner join kid on kid.b_id=driver.b_id '
143 | 'inner join parent on parent.id=kid.p_id where parent.token=? and kid.id=? ) order by '
144 | 'location.id desc limit 100',
145 | [self.token, self.kid_id])
146 | res = cur.fetchall()
147 | if res is None:
148 | return []
149 | else:
150 | return [{"id":i[0],"gps": i[1], "time": i[2]} for i in res]
151 |
--------------------------------------------------------------------------------
/BusTrack/views/parent.py:
--------------------------------------------------------------------------------
1 | from flask import Blueprint, make_response, render_template, request, jsonify, abort, send_file
2 | from BusTrack.models.Rides import ActiveRide, BusArriving, Track
3 | from BusTrack.models.Parent import Parent
4 | from BusTrack.helpers import SessionHelper, utils
5 | from BusTrack.models.Kid import Kid
6 | from BusTrack.models.feedback import Feedback
7 | from functools import wraps
8 |
9 | parent = Blueprint('parent', __name__)
10 |
11 | # method to check valid parent and return access token
12 | '''
13 | request:
14 | {
15 | "username":"uname",
16 | password:"pass"
17 | }
18 | response:
19 | {
20 | "status":"ok|error",
21 | "message":"error type"
22 | "token":"valid_till",
23 | "name":"parent name",
24 | "email","phone",
25 | }
26 | '''
27 |
28 |
29 | @parent.route('/access_token', methods=['POST'])
30 | def login():
31 | js = request.json
32 | if js is not None:
33 | if 'username' in js and 'password' in js:
34 | email = js['username']
35 | _pass = js['password']
36 | parent = Parent.get_user(email)
37 | if parent is None:
38 | return make_response(jsonify(status='error', message='invalid user'), 403)
39 | name = parent[1]
40 | phone = parent[3]
41 | pass_hash = parent[4]
42 | if pass_hash is not False and SessionHelper.is_password_correct(pass_hash, _pass):
43 | # ok correct user
44 | m_token = utils.rand(40)
45 | m_expire = utils.get_expiry_date_full()
46 | # update this token
47 | Parent.update_token(email, m_token, m_expire)
48 | return jsonify(status='ok', message='ok login', token=m_token, expires=m_expire, name=name, phone=phone,
49 | email=email)
50 | else:
51 | return make_response(jsonify(status='error', message='invalid user'), 403)
52 | else:
53 | return jsonify(status='error', message='incorrect parameters')
54 | else:
55 | return jsonify(status='error', message='only json body is allowed')
56 |
57 |
58 | # verify token
59 | def token_required(f):
60 | @wraps(f)
61 | def decorated_function(*args, **kwargs):
62 | if 'token' in request.args and Parent.is_valid_token(request.args['token']):
63 | pass
64 | else:
65 | return make_response(jsonify(status='error', message='unauthorized user'), 403)
66 |
67 | return f(*args, **kwargs)
68 |
69 | return decorated_function
70 |
71 |
72 | # return kids detail of this parent
73 | @parent.route('/get_kids', methods=['GET', 'POST'])
74 | @token_required
75 | def get_my_kids():
76 | return jsonify(kids=Parent.get_kids(request.args['token']), status='ok', message='ok')
77 |
78 |
79 | # get all active ride for kids of this parent
80 | @parent.route('/active_rides')
81 | @token_required
82 | def get_kid_status():
83 | try:
84 | r = ActiveRide(request.args['token'])
85 | if 'kid_id' in request.args:
86 | # request for only 1 kid
87 | # TODO: check only authorized parent, can access rides only for his kids
88 | kid_id = request.args['kid_id']
89 | return jsonify(rides=r.get_single_status(kid_id), status='ok', message='ok fetched')
90 | else:
91 | return jsonify(rides=r.get_active_ride(), status='ok', message='ok fetched')
92 | except:
93 | return make_response(jsonify(status='error'), 403)
94 |
95 |
96 | # get all rides weather completed or incomplete associated to this kid
97 | @parent.route('/recent_rides', methods=['GET', 'POST'])
98 | @token_required
99 | def get_recent_ride():
100 | # requires param kid_id
101 | if 'kid_id' in request.args:
102 | kid_id = request.args['kid_id']
103 | token = request.args['token']
104 | # if parent is authorised for this kid
105 | if not Parent.is_kidOf(kid_id, token):
106 | return make_response(jsonify(status='error', message='un-authorized access'), 403)
107 | try:
108 | a = ActiveRide(token)
109 | return jsonify(rides=a.get_recent_rides(kid_id), status='ok', message='fetched recent rides')
110 | except:
111 | return make_response(jsonify(status='error'), 403)
112 | else:
113 | return jsonify(status='error', message='incorrect request')
114 |
115 |
116 | # fetch kid photo
117 | @parent.route('/photo_kid')
118 | @token_required
119 | def get_kid_photo():
120 | if 'kid_id' in request.args:
121 | k_id = request.args['kid_id']
122 | token = request.args['token']
123 | img_name = Kid.get_image_for_parent(token, k_id)
124 | if img_name is None:
125 | abort(404)
126 | else:
127 | from BusTrack import app
128 | final_image = app.config['IMAGE_KID'] + img_name
129 | # import os
130 | # filename = os.path.join(app.root_path,img_name)
131 | try:
132 | return send_file(final_image, mimetype='image/jpeg')
133 | except:
134 | abort(404)
135 | else:
136 | abort(404)
137 |
138 |
139 | # get feedback from parent
140 | @parent.route('/feedback', methods=['POST'])
141 | @token_required
142 | def feedback():
143 | js = request.json
144 | if 'title' in js and 'detail' in js:
145 | token = request.args['token']
146 | title = js['title']
147 | detail = js['detail']
148 | date = utils.get_date_full()
149 | p = Parent.get_parent_id(token)
150 | p_id = p[0]
151 | name = p[1]
152 | email = p[2]
153 | f = Feedback(name=name, email=email, title=title, message=detail, date=date, p_id=p_id)
154 | f.add()
155 | return jsonify(status='ok', message='feedback sent')
156 | else:
157 | return jsonify(status='error', message='incorrect request')
158 |
159 |
160 | # get list of arriving bus for the kids of this parent
161 | @parent.route('/arriving', methods=['GET'])
162 | @token_required
163 | def arriving_bus():
164 | # if 'kid_id' in request.args:
165 | token = request.args['token']
166 | r = BusArriving(token)
167 | return jsonify(status='ok', buses=r.arriving_buses())
168 |
169 |
170 | # get current gps status for bus
171 | @parent.route('/location', methods=['GET', 'POST'])
172 | @token_required
173 | def latest_location():
174 | if 'kid_id' in request.args:
175 | token = request.args['token']
176 | kid_id = request.args['kid_id']
177 | t = Track(token, kid_id)
178 | res = t.get_latest_location()
179 | if res is None:
180 | return jsonify(status='completed', message='Ride already completed')
181 | else:
182 | return jsonify(status='ok', gps=res[0], last_update=res[1])
183 | else:
184 | return jsonify(status='error', message='incorrect parameters')
185 |
186 |
187 | # get all location associated to a journey
188 | @parent.route('/locations', methods=['GET'])
189 | @token_required
190 | def all_location():
191 | if 'kid_id' in request.args:
192 | kid_id = request.args['kid_id']
193 | token = request.args['token']
194 | t = Track(token, kid_id)
195 | res = t.get_all_locations()
196 | return jsonify(status='ok', locations=res)
197 | else:
198 | return jsonify(status='error', message='incorrect parameters')
199 |
200 |
201 | # upload image of a kid
202 | @parent.route('/upload',methods=['GET','POST'])
203 | @token_required
204 | def upload_image():
205 | token=request.args['token']
206 | if 'kid_id' in request.args and 'file' in request.files:
207 | kid_id=request.args['kid_id']
208 | image=request.files['file']
209 | file_name=image.filename
210 | image.save(file_name)
211 |
212 |
--------------------------------------------------------------------------------
/BusTrack/views/driver.py:
--------------------------------------------------------------------------------
1 | from flask import Blueprint, make_response, request, jsonify, abort, send_file, send_from_directory
2 | from BusTrack.models.driver import Driver
3 | from BusTrack.models.journey import Journey
4 | from BusTrack.models.gps import Gps
5 | from BusTrack.models.attendance import Attendance
6 | from BusTrack.models.location import Location
7 | from BusTrack.models.Kid import Kid
8 | from BusTrack.helpers import SessionHelper, utils
9 | from functools import wraps
10 |
11 | driver = Blueprint('driver', __name__)
12 |
13 | # method to check valid driver and return access token to be used by him
14 | '''
15 | # request object
16 | {
17 | username:"username",
18 | password:"password"
19 | }
20 |
21 | # response object
22 | {
23 | status:"ok|error"
24 | valid_till:"duration of expiry",
25 | token:"send generated access token",
26 | name:"name of driver",
27 | bus:"bus number"
28 | message:"String message responding status related to success or failure."
29 | }
30 | '''
31 |
32 |
33 | @driver.route('/access_token', methods=['POST'])
34 | def login():
35 | # require username,password as json
36 | js = request.json
37 | if js is not None:
38 | if 'username' in js and 'password' in js and 'journey_type' in js:
39 | u_id = js['username']
40 | _pass = js['password']
41 | j_type = js['journey_type']
42 | # validate j_type
43 | if j_type not in [0, 1]:
44 | return jsonify(status="error", message="Incorrect journey type")
45 |
46 | user = Driver.get_user(u_id)
47 | if not user:
48 | return make_response(jsonify(status='error', message='Invalid Credential'), 403)
49 | name = user[0]
50 | pass_hash = user[1]
51 | bus_no = user[2]
52 |
53 | if pass_hash is not False and SessionHelper.is_password_correct(pass_hash, _pass):
54 | # ok correct user
55 | # make sure, if similar ride is not already completed by this driver
56 | if Driver.is_ride_already_completed(u_id, j_type):
57 | return jsonify(status='error', message='ride already completed for today.')
58 | # get active ride
59 | active_ride = user[3]
60 | # generate a random token
61 | m_token = utils.rand(40)
62 | m_expire = utils.get_expiry_date_full()
63 | Driver.update_token(m_token, m_expire, u_id)
64 | if active_ride is None or active_ride is '':
65 | # no active session, start new session
66 | # and create new journey and set it
67 | bus_id = user[4]
68 | Journey.trans_create_journey(j_type, utils.get_date_full(), bus_id, u_id)
69 | else:
70 | # no need to create new journey
71 | pass
72 | return jsonify(status="ok", message="Correct Credentials", token=m_token, valid_till=m_expire,
73 | name=name, bus=bus_no)
74 | else:
75 | return make_response(jsonify(status="error", message="Invalid Credential"), 403)
76 | else:
77 | return jsonify(status="error", message="Incorrect Request")
78 | else:
79 | return jsonify(status="error", message="Only Json Body is allowed")
80 |
81 | # - a decorator to check validity of token
82 |
83 |
84 | def token_required(f):
85 | @wraps(f)
86 | def decorated_function(*args, **kwargs):
87 | if 'token' in request.args and Driver.is_valid_token(request.args['token']):
88 | pass
89 | else:
90 | return make_response(jsonify(status='error', message='unauthorized user'), 403)
91 |
92 | return f(*args, **kwargs)
93 |
94 | return decorated_function
95 |
96 |
97 | # add gps data of this driver
98 | '''
99 | #request object
100 | ..api/v1/driver/add_gps?token="mToken"
101 | {
102 | lat:"latitude",
103 | lon:"longitude",
104 | }
105 |
106 | # response object
107 | {
108 | status:"ok|error",
109 | message:"error message if any"
110 | }
111 | '''
112 |
113 |
114 | @driver.route('/add_gps', methods=['POST'])
115 | @token_required
116 | def add_gps():
117 | js = request.json
118 | if 'lat' in js and 'lon' in js:
119 | token = request.args['token']
120 | lat = js['lat']
121 | lon = js['lon']
122 | # add location to this active journey
123 | print(lat, lon)
124 | j_id = Driver.get_active_ride(request.args['token'])
125 | if j_id is None or j_id is '':
126 | return jsonify(status='error', message='unauthorized user or inactive session')
127 | else:
128 | # add location to location table
129 | # check if 1 minute passed since last update
130 | if Location.is_delta_time_passed(j_id, utils.get_prev_time()):
131 | # now add location
132 | l = Location(Gps.tuple_to_str(lat, lon), j_id)
133 | l.add()
134 | print("adding location...")
135 | # update gps table
136 | Journey.update_gps(j_id, Gps.tuple_to_str(lat, lon))
137 |
138 | return jsonify(status="ok", message="Gps data added")
139 | else:
140 | return jsonify(status='error', message='Incorrect parameters')
141 |
142 |
143 | # logout for driver
144 | @driver.route('/logout', methods=['GET', 'POST'])
145 | @token_required
146 | def logout():
147 | # set this journey_id to null for this driver
148 | # and also set end time
149 | token = request.args['token']
150 | # check all attendance stuff are already done by driver
151 | Driver.logout_session(token)
152 | return jsonify(status='ok')
153 |
154 |
155 | # get list of kids in bus at pick time
156 | # 1) list of kids whose attendance is already taken ?present=1
157 | # 2) list of kids whom attendance is not yet taken ?present=0
158 | @driver.route('/get_kids', methods=['GET', 'POST'])
159 | @token_required
160 | def get_kids():
161 | if 'present' in request.args:
162 | # but make sure a ride session exists
163 | j_id = Driver.get_active_ride(request.args['token'])
164 | if j_id is None or j_id is '':
165 | return jsonify(status='error', message='No active ride.')
166 | present = request.args['present']
167 | token = request.args['token']
168 | if present is '1' or present is 1:
169 | kids = Attendance.get_kid_attended(token)
170 | return jsonify(status='ok', kids=kids_json(kids))
171 | elif present is '0' or present is 0:
172 | kids = Attendance.get_kid_not_attended(token)
173 | return jsonify(status='ok', kids=kids_json(kids))
174 | else:
175 | return jsonify(status='error', message='present arg can be 0 or 1')
176 | else:
177 | return jsonify(status='error', message='incorrect request')
178 |
179 |
180 | # get list of kids at drop time
181 | # 1) kids who are not yet dropped ?dropped=0
182 | # 2) kids who are already dropped ?dropped=1
183 | @driver.route('/get_kids_dropped', methods=['GET', 'POST'])
184 | @token_required
185 | def get_kids_by_dropping():
186 | if 'dropped' in request.args:
187 | # but make sure a ride session exists
188 | j_id = Driver.get_active_ride(request.args['token'])
189 | if j_id is None or j_id is '':
190 | return jsonify(status='error', message='No active ride.')
191 | dropped = request.args['dropped']
192 | token = request.args['token']
193 | if dropped is '1' or dropped is 1:
194 | kids = Attendance.get_kid_dropped(token)
195 | return jsonify(status='ok', kids=kids_json(kids))
196 | elif dropped is '0' or dropped is 0:
197 | kids = Attendance.get_kid_not_dropped(token)
198 | return jsonify(status='ok', kids=kids_json(kids))
199 | else:
200 | return jsonify(status='error', message='present arg can be 0 or 1')
201 | else:
202 | return jsonify(status='error', message='incorrect request')
203 |
204 |
205 | # make attendance function
206 | # for pick up
207 | '''
208 | --request format
209 | {
210 | "kid_ids":[1,2,3,4,...],
211 | "lat":12.5,
212 | "lon":53.254
213 | }
214 | # send ids of kid
215 | --response
216 | "status":"ok","message":"msg.."
217 | '''
218 |
219 |
220 | @driver.route('/add_pick_attendance', methods=['POST'])
221 | def pick_attendance():
222 | js = request.json
223 | if 'kid_ids' in js and 'lat' in js and 'lon' in js:
224 | ids = js['kid_ids']
225 | lat = js['lat']
226 | lon = js['lon']
227 | gps = Gps.tuple_to_str(lat, lon)
228 | time = utils.get_date_full()
229 | token = request.args['token']
230 | j_id = Driver.get_active_ride(token)
231 | if j_id is None or j_id is '':
232 | return jsonify(status='error', message='Cant add,as not active ride')
233 | else:
234 | # filter valid ids
235 | id_from_db = Kid.get_kid_ids(j_id)
236 | ids_set = set(ids)
237 | ids_db_set = set(id_from_db)
238 | ids_valid = list(ids_set & ids_db_set) # intersection of kid ids
239 | for id in ids_valid:
240 | atten = Attendance(pick_present=1, kid_id=id, journey_id=j_id, pick_gps=gps, pick_time=time)
241 | atten.add()
242 | return jsonify(status='ok', message='Attendance taken')
243 | else:
244 | return jsonify(status='error', message='incorrect request')
245 |
246 |
247 | @driver.route('/add_drop_attendance', methods=['POST'])
248 | def drop_attendance():
249 | js = request.json
250 | if 'kid_ids' in js and 'lat' in js and 'lon' in js:
251 | ids = js['kid_ids']
252 | lat = js['lat']
253 | lon = js['lon']
254 | gps = Gps.tuple_to_str(lat, lon)
255 | time = utils.get_date_full()
256 | token = request.args['token']
257 | j_id = Driver.get_active_ride(token)
258 | if j_id is None or j_id is '':
259 | return jsonify(status='error', message='Cant add,since not active ride')
260 | else:
261 | # filter valid ids
262 | id_from_db = Kid.get_kid_drop_not_present(j_id)
263 | ids_set = set(ids)
264 | ids_db_set = set(id_from_db)
265 | ids_valid = list(ids_set & ids_db_set) # intersection of kid ids
266 | for id in ids_valid:
267 | Attendance.update_drop_attendance(id, gps, time, j_id)
268 | return jsonify(status='ok', message='Attendance taken')
269 | else:
270 | return jsonify(status='error', message='incorrect request')
271 |
272 |
273 | # convert kids list to json compatible dictionary-list
274 | def kids_json(kids):
275 | lst = []
276 | for k in kids:
277 | dic = {'name': k.name, 'section': k.section, 'id': k.id}
278 | # TODO: create logic to create image link
279 | # dic['photo']
280 | lst.append(dic)
281 | return lst
282 |
283 |
284 | @driver.route('/photo_kid')
285 | @token_required
286 | def get_kid_photo():
287 | if 'kid_id' in request.args:
288 | k_id = request.args['kid_id']
289 | token = request.args['token']
290 | img_name = Kid.get_image_for_driver(token, k_id)
291 | if img_name is None:
292 | abort(404)
293 | else:
294 | from BusTrack import app
295 | final_image = app.config['IMAGE_KID'] + img_name
296 | try:
297 | return send_file(final_image, mimetype='image/jpeg')
298 | except:
299 | abort(404)
300 | else:
301 | abort(404)
302 |
303 |
304 | # get information about ride completed by this driver
305 | '''
306 | request:get_rides?token=xyz...
307 |
308 | response:
309 | {
310 | "rides":[{
311 | "start_time":"time","end_time":"time","duration":"calculate it on front end",
312 | "type":"1 or 0",
313 |
314 | },..]
315 | }
316 | '''
317 |
--------------------------------------------------------------------------------
/BusTrack/static/fonts_/Roboto/LICENSE.txt:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see
.
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 |
.
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 |
.
675 |
--------------------------------------------------------------------------------