Feature/import to calendar (#119)

* feat: import file to calendar

Author: Nir-P

app/config.py.example

@@ -45,6 +45,15 @@ email_conf = ConnectionConfig(
     USE_CREDENTIALS=True,
 )
 
+# import
+MAX_FILE_SIZE_MB = 5  # 5MB
+VALID_FILE_EXTENSION = (".txt", ".csv", ".ics")  # Can import only these files.
+# Events must be within 20 years range from the current year.
+EVENT_VALID_YEARS = 20
+EVENT_HEADER_NOT_EMPTY = 1  # 1- for not empty, 0- for empty.
+EVENT_HEADER_LIMIT = 50  # Max characters for event header.
+EVENT_CONTENT_LIMIT = 500  # Max characters for event characters.
+MAX_EVENTS_START_DATE = 10  # Max Events with the same start date.
 # PATHS
 STATIC_ABS_PATH = os.path.abspath("static")
 

app/internal/import_file.py

@@ -0,0 +1,200 @@
+from collections import defaultdict
+import datetime
+import os
+from pathlib import Path
+import re
+from typing import Any, Dict, Generator, List, Tuple, Union
+
+from icalendar import Calendar
+
+from app.config import (
+    EVENT_CONTENT_LIMIT,
+    EVENT_HEADER_LIMIT,
+    EVENT_HEADER_NOT_EMPTY,
+    EVENT_VALID_YEARS,
+    MAX_EVENTS_START_DATE,
+    MAX_FILE_SIZE_MB,
+    VALID_FILE_EXTENSION
+)
+from app.database.database import SessionLocal
+from app.routers.event import create_event
+from loguru import logger
+
+
+DATE_FORMAT = "%m-%d-%Y"
+DESC_EVENT = "VEVENT"
+EVENT_PATTERN = re.compile(r"^(\w{" + str(EVENT_HEADER_NOT_EMPTY) + "," +
+                           str(EVENT_HEADER_LIMIT) + r"}),\s(\w{0," +
+                           str(EVENT_CONTENT_LIMIT) +
+                           r"}),\s(\d{2}-\d{2}-\d{4})," +
+                           r"\s(\d{2}-\d{2}-\d{4})$")
+
+
+def is_file_size_valid(file: str, max_size: int = MAX_FILE_SIZE_MB) -> bool:
+    file_size = os.stat(file).st_size / 1048576  # convert bytes to MB.
+    return file_size <= max_size
+
+
+def is_file_extension_valid(file: str,
+                            extension: Union[str, Tuple[str, ...]]
+                            = VALID_FILE_EXTENSION) -> bool:
+    return file.lower().endswith(extension)
+
+
+def is_file_exist(file: str) -> bool:
+    return Path(file).is_file()
+
+
+def is_date_in_range(date: Union[str, datetime.datetime],
+                     valid_dates: int = EVENT_VALID_YEARS) -> bool:
+    """
+    check if date is valid and in the range according to the rule we have set
+    """
+    now_year = datetime.datetime.now().year
+    if isinstance(date, str):
+        try:
+            check_date = datetime.datetime.strptime(date, DATE_FORMAT)
+        except ValueError:
+            return False
+    else:
+        check_date = date
+    return now_year - valid_dates < check_date.year < now_year + valid_dates
+
+
+def is_event_text_valid(row: str) -> bool:
+    """Check if the row contains valid data"""
+    get_values = EVENT_PATTERN.search(row)
+    return get_values is not None
+
+
+def is_file_valid_to_import(file: str) -> bool:
+    """
+    checking before importing that the file exist, the file extension and
+    the size meet the rules we have set.
+    """
+    return (is_file_exist(file) and is_file_extension_valid(file) and
+            is_file_size_valid(file))
+
+
+def is_file_valid_to_save_to_database(events: List[Dict[str, Union[str, Any]]],
+                                      max_event_start_date: int
+                                      = MAX_EVENTS_START_DATE) -> bool:
+    """
+    checking after importing that there is no larger quantity of events
+    with the same date according to the rule we have set.
+    """
+    same_date_counter = 1
+    date_n_count = defaultdict(int)
+    for event in events:
+        date_n_count[event["S_Date"]] += 1
+        if date_n_count[event["S_Date"]] > same_date_counter:
+            same_date_counter = date_n_count[event["S_Date"]]
+    return same_date_counter <= max_event_start_date
+
+
+def open_txt_file(txt_file: str) -> Generator[str, None, None]:
+    with open(txt_file, "r") as text:
+        for row in text.readlines():
+            yield row
+
+
+def save_calendar_content_txt(event: str, calendar_content: List) -> bool:
+    """populate calendar with event content"""
+    head, content, start_date, end_date = event.split(", ")
+    if (not is_date_in_range(start_date) or
+       not is_date_in_range(end_date.replace("\n", ""))):
+        return False
+    start_date = datetime.datetime.strptime(start_date, DATE_FORMAT)
+    end_date = datetime.datetime.strptime(end_date.replace("\n", ""),
+                                          DATE_FORMAT)
+    calendar_content.append({"Head": head,
+                             "Content": content,
+                             "S_Date": start_date,
+                             "E_Date": end_date})
+    return True
+
+
+def import_txt_file(txt_file: str) -> List[Dict[str, Union[str, Any]]]:
+    calendar_content = []
+    for event in open_txt_file(txt_file):
+        if (not is_event_text_valid(event) or
+           not save_calendar_content_txt(event, calendar_content)):
+            return []
+    return calendar_content
+
+
+def open_ics(ics_file: str) -> Union[List, Calendar]:
+    with open(ics_file, "r") as ics:
+        try:
+            calendar_read = Calendar.from_ical(ics.read())
+        except (IndexError, ValueError) as e:
+            logger.error(f"open_ics function failed error message: {e}")
+            return []
+    return calendar_read
+
+
+def is_valid_data_event_ics(component) -> bool:
+    """check if ics event data content is valid"""
+    return not (str(component.get('summary')) is None or
+                component.get('dtstart') is None or
+                component.get('dtend') is None or
+                not is_date_in_range(component.get('dtstart').dt) or
+                not is_date_in_range(component.get('dtend').dt))
+
+
+def save_calendar_content_ics(component, calendar_content) -> None:
+    calendar_content.append({
+                        "Head": str(component.get('summary')),
+                        "Content": str(component.get('description')),
+                        "S_Date": component.get('dtstart').dt
+                        .replace(tzinfo=None),
+                        "E_Date": component.get('dtend').dt
+                        .replace(tzinfo=None)
+                    })
+
+
+def import_ics_file(ics_file: str) -> List[Dict[str, Union[str, Any]]]:
+    calendar_content = []
+    calendar_read = open_ics(ics_file)
+    if not calendar_read:
+        return []
+    for component in calendar_read.walk():
+        if component.name == DESC_EVENT:
+            if not is_valid_data_event_ics(component):
+                return []
+            save_calendar_content_ics(component, calendar_content)
+    return calendar_content
+
+
+def save_events_to_database(events: List[Dict[str, Union[str, Any]]],
+                            user_id: int,
+                            session: SessionLocal) -> None:
+    """insert the events into Event table"""
+    for event in events:
+        title = event["Head"]
+        content = event["Content"]
+        start = event["S_Date"]
+        end = event["E_Date"]
+        owner_id = user_id
+        create_event(db=session,
+                     title=title,
+                     content=content,
+                     start=start,
+                     end=end,
+                     owner_id=owner_id)
+
+
+def user_click_import(file: str, user_id: int, session: SessionLocal) -> bool:
+    """
+    when user choose a file and click import, we are checking the file
+    and if everything is ok we will insert the data to DB
+    """
+    if is_file_valid_to_import(file):
+        if is_file_extension_valid(file, ".ics"):
+            import_file = import_ics_file(file)
+        else:
+            import_file = import_txt_file(file)
+        if import_file and is_file_valid_to_save_to_database(import_file):
+            save_events_to_database(import_file, user_id, session)
+            return True
+    return False

requirements.txt

@@ -0,0 +1,32 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+SUMMARY:HeadA
+DTSTART;TZID=America/New_York:20190802T103400
+DTEND;TZID=America/New_York:20190802T110400
+LOCATION:1000 Broadway Ave.\, Brooklyn
+DESCRIPTION:Content1
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:desc_1
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:HeadB
+DTSTART;TZID=America/New_York:20190802T200000
+DTEND;TZID=America/New_York:20190802T203000
+LOCATION:900 Jay St.\, Brooklyn
+DESCRIPTION:Content2
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:desc_2
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+END:VCALENDAR

tests/files_for_import_file_tests/sample.ics

@@ -0,0 +1,32 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+CALSCALE:GREGORIAN
+
+SUMMARY:HeadA
+DTSTART;TZID=America/New_York:20190802T103400
+DTEND;TZID=America/New_York:20190802T110400
+LOCATION:1000 Broadway Ave.\, Brooklyn
+DESCRIPTION:Content1
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:desc_1
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:HeadB
+DTSTART;TZID=America/New_York:20190802T200000
+DTEND;TZID=America/New_York:20190802T203000
+LOCATION:900 Jay St.\, Brooklyn
+DESCRIPTION:Content2
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:desc_2
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+END:VCALENDAR

tests/files_for_import_file_tests/sample2.blabla

@@ -0,0 +1,32 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+
+
+
+LOCATION:1000 Broadway Ave.\, Brooklyn
+DESCRIPTION:Content1
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:desc_1
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:HeadB
+DTSTART;TZID=America/New_York:20190802T200000
+DTEND;TZID=America/New_York:20190802T203000
+LOCATION:900 Jay St.\, Brooklyn
+DESCRIPTION:Content2
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:desc_2
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+END:VCALENDAR