def android_client_get_ics(resource_type, identifier, semester):
"""
android client get a student or teacher's ics file
If the student does not have privacy mode, anyone can use student number to subscribe his calendar.
If the privacy mode is on and there is no HTTP basic authentication, return a 401(unauthorized)
status code and the Android client ask user for password to try again.
"""
from flask import redirect, url_for, request
from everyclass.server.db.dao import PrivacySettings, CalendarToken, User
from everyclass.server.rpc.api_server import APIServer
from everyclass.server.utils.resource_identifier_encrypt import decrypt
# 检查 URL 参数
try:
res_type, res_id = decrypt(identifier)
except ValueError:
return "Invalid identifier", 400
if resource_type not in ('student', 'teacher') or resource_type != res_type:
return "Unknown resource type", 400
if resource_type == 'teacher':
try:
teacher = APIServer.get_teacher_timetable(res_id, semester)
except Exception as e:
return handle_exception_with_error_page(e)
cal_token = CalendarToken.get_or_set_calendar_token(resource_type=resource_type,
identifier=teacher.teacher_id,
semester=semester)
return redirect(url_for('calendar.ics_download', calendar_token=cal_token))
else: # student
try:
student = APIServer.get_student_timetable(res_id, semester)
except Exception as e:
return handle_exception_with_error_page(e)
with elasticapm.capture_span('get_privacy_settings'):
privacy_level = PrivacySettings.get_level(student.student_id)
# get authorization from HTTP header and verify password if privacy is on
if privacy_level != 0:
if not request.authorization:
return "Unauthorized (privacy on)", 401
username, password = request.authorization
if not User.check_password(username, password):
return "Unauthorized (password wrong)", 401
if student.student_id != username:
return "Unauthorized (username mismatch)", 401
cal_token = CalendarToken.get_or_set_calendar_token(resource_type=resource_type,
identifier=student.student_id,
semester=semester)
return redirect(url_for('calendar.ics_download', calendar_token=cal_token))
def ics_download(calendar_token: str):
"""
iCalendar ics file download
因为课表会更新，所以 ics 文件只能在这里动态生成，不能在日历订阅页面就生成
"""
from collections import defaultdict
from flask import send_from_directory
from everyclass.server.db.dao import CalendarToken
from everyclass.server.models import Semester
from everyclass.server.calendar import ics_generator
from everyclass.server.rpc.api_server import APIServer, teacher_list_to_name_str
from everyclass.server.utils import lesson_string_to_tuple
result = CalendarToken.find_calendar_token(token=calendar_token)
if not result:
return 'invalid calendar token', 404
CalendarToken.update_last_used_time(calendar_token)
# 获得原始学号或教工号
if result['type'] == 'student':
rpc_result = APIServer.get_student_timetable(result['identifier'],
result['semester'])
else:
# teacher
rpc_result = APIServer.get_teacher_timetable(result['identifier'],
result['semester'])
with elasticapm.capture_span('process_rpc_result'):
semester = Semester(result['semester'])
cards: Dict[Tuple[int, int], List[Dict]] = defaultdict(list)
for card in rpc_result.cards:
day, time = lesson_string_to_tuple(card.lesson)
cards[(day, time)].append(
dict(name=card.name,
teacher=teacher_list_to_name_str(card.teachers),
week=card.weeks,
week_string=card.week_string,
classroom=card.room,
cid=card.card_id_encoded))
ics_generator.generate(name=rpc_result.name,
cards=cards,
semester=semester,
ics_token=calendar_token)
return send_from_directory("../../calendar_files",
calendar_token + ".ics",
as_attachment=True,
mimetype='text/calendar')
def cal_page(url_res_type: str, url_res_identifier: str, url_semester: str):
"""课表导出页面视图函数"""
from flask import current_app as app, render_template, url_for
from everyclass.server.db.dao import CalendarToken
from everyclass.server.consts import MSG_400
from everyclass.server.rpc.api_server import APIServer
from everyclass.server.utils.resource_identifier_encrypt import decrypt
from everyclass.server.consts import MSG_INVALID_IDENTIFIER
# 检查 URL 参数
try:
res_type, res_id = decrypt(url_res_identifier)
except ValueError:
return render_template("common/error.html", message=MSG_INVALID_IDENTIFIER)
if url_res_type not in ('student', 'teacher') or url_res_type != res_type:
return render_template("common/error.html", message=MSG_400)
if url_res_type == 'student':
try:
student = APIServer.get_student_timetable(res_id, url_semester)
except Exception as e:
return handle_exception_with_error_page(e)
# 权限检查，如果没有权限则返回
has_permission, return_val = check_permission(student)
if not has_permission:
return return_val
token = CalendarToken.get_or_set_calendar_token(resource_type=url_res_type,
identifier=student.student_id,
semester=url_semester)
else:
try:
teacher = APIServer.get_teacher_timetable(res_id, url_semester)
except Exception as e:
return handle_exception_with_error_page(e)
token = CalendarToken.get_or_set_calendar_token(resource_type=url_res_type,
identifier=teacher.teacher_id,
semester=url_semester)
ics_url = url_for('calendar.ics_download', calendar_token=token, _external=True)
ics_webcal = ics_url.replace('https', 'webcal').replace('http', 'webcal')
return render_template('calendarSubscribe.html',
ics_url=ics_url,
ics_webcal=ics_webcal,
android_client_url=app.config['ANDROID_CLIENT_URL'])
def legacy_get_ics(student_id, semester_str):
"""
早期 iCalendar 订阅端点，出于兼容性考虑保留，仅支持未设定隐私等级的学生，其他情况使用新的日历订阅令牌获得 ics 文件。
"""
# fix parameters
place = student_id.find('-')
semester_str = student_id[place + 1:len(student_id)] + '-' + semester_str
student_id = student_id[:place]
semester = Semester(semester_str)
search_result = Entity.search(student_id)
if len(search_result.students) != 1:
# bad request
return abort(400)
if semester.to_str() not in search_result.students[0].semesters:
return abort(400)
with tracer.trace('get_privacy_settings'):
privacy_settings = PrivacySettings.get_level(
search_result.students[0].student_id)
if privacy_settings != 0:
# force user to get a calendar token when the user is privacy-protected but accessed through legacy interface
return "Visit {} to get your calendar".format(
url_for("main.main", _external=True)), 401
else:
token = CalendarToken.get_or_set_calendar_token(
resource_type="student",
identifier=search_result.students[0].student_id,
semester=semester.to_str())
return redirect(url_for('calendar.ics_download', calendar_token=token))
def reset_calendar_token():
"""重置日历订阅令牌"""
CalendarToken.reset_tokens(session[SESSION_CURRENT_USER].sid_orig)
flash("日历订阅令牌重置成功")
return redirect(url_for("user.main"))
def ics_download(calendar_token: str):
"""
iCalendar ics 文件下载
2019-8-25 改为预先缓存文件而非每次动态生成，降低 CPU 压力。如果一小时内两次访问则强刷缓存。
"""
import time
from everyclass.server import statsd
if not is_valid_uuid(calendar_token):
return 'invalid calendar token', 404
result = CalendarToken.find_calendar_token(token=calendar_token)
if not result:
return 'invalid calendar token', 404
CalendarToken.update_last_used_time(calendar_token)
cal_dir = calendar_dir()
cal_filename = f"{result['type']}_{result['identifier']}_{result['semester']}.ics"
cal_full_path = os.path.join(cal_dir, cal_filename)
# 有缓存、且缓存时间小于一天，且不用强刷缓存
if os.path.exists(cal_full_path) \
and time.time() - os.path.getmtime(cal_full_path) < SECONDS_IN_ONE_DAY \
and Redis.calendar_token_use_cache(calendar_token):
logger.info("ics cache hit")
statsd.increment("calendar.ics.cache.hit")
return send_from_directory(cal_dir,
cal_filename,
as_attachment=True,
mimetype='text/calendar')
statsd.increment("calendar.ics.cache.miss")
# 无缓存、或需要强刷缓存
with tracer.trace('rpc'):
# 获得原始学号或教工号
if result['type'] == 'student':
rpc_result = Entity.get_student_timetable(result['identifier'],
result['semester'])
else:
# teacher
rpc_result = Entity.get_teacher_timetable(result['identifier'],
result['semester'])
semester = Semester(result['semester'])
cards: Dict[Tuple[int, int], List[Dict]] = defaultdict(list)
for card in rpc_result.cards:
cards[lesson_string_to_tuple(card.lesson)].append(
dict(name=card.name,
teacher=teacher_list_to_name_str(card.teachers),
week=card.weeks,
week_string=card.week_string,
classroom=card.room,
cid=card.card_id_encoded))
ics_generator.generate(name=rpc_result.name,
cards=cards,
semester=semester,
filename=cal_filename)
return send_from_directory(cal_dir,
cal_filename,
as_attachment=True,
mimetype='text/calendar')