├── auth ├── admin.py ├── __init__.py ├── models.py ├── tests.py ├── apps.py ├── __pycache__ │ ├── urls.cpython-39.pyc │ ├── views.cpython-39.pyc │ ├── __init__.cpython-39.pyc │ └── serializers.cpython-39.pyc ├── urls.py ├── serializers.py └── views.py ├── api ├── __init__.py ├── migrations │ ├── __init__.py │ ├── __pycache__ │ │ ├── __init__.cpython-39.pyc │ │ ├── 0001_initial.cpython-39.pyc │ │ └── 0002_auto_20210707_1851.cpython-39.pyc │ ├── 0002_auto_20210707_1851.py │ └── 0001_initial.py ├── apps.py ├── utils.py ├── admin.py ├── urls.py ├── models.py ├── serializers.py ├── views.py └── tests.py ├── statistic ├── __init__.py ├── management │ ├── __init__.py │ ├── commands │ │ ├── __init__.py │ │ ├── _private.py │ │ ├── __pycache__ │ │ │ ├── __init__.cpython-39.pyc │ │ │ └── monthly_report.cpython-39.pyc │ │ └── monthly_report.py │ └── __pycache__ │ │ └── __init__.cpython-39.pyc ├── migrations │ ├── __init__.py │ ├── __pycache__ │ │ ├── __init__.cpython-39.pyc │ │ ├── 0001_initial.cpython-39.pyc │ │ ├── 0002_auto_20210707_2130.cpython-39.pyc │ │ ├── 0003_auto_20210708_1549.cpython-39.pyc │ │ └── 0004_auto_20210710_1343.cpython-39.pyc │ ├── 0002_auto_20210707_2130.py │ ├── 0003_auto_20210708_1549.py │ ├── 0004_auto_20210710_1343.py │ └── 0001_initial.py ├── apps.py ├── admin.py ├── serializers.py ├── models.py ├── urls.py ├── report.py ├── views.py └── utils.py ├── runtime.txt ├── Procfile ├── config ├── asgi.py ├── wsgi.py ├── urls.py ├── dev-settings.py └── settings.py ├── clock.py ├── env.cmd ├── env.sh ├── .gitignore ├── templates ├── email.txt └── email.html ├── manage.py ├── requirements.txt ├── README.md └── LICENSE /auth/admin.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /api/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /auth/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /statistic/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /api/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /runtime.txt: -------------------------------------------------------------------------------- 1 | python-3.9.6 2 | -------------------------------------------------------------------------------- /statistic/management/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /statistic/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /statistic/management/commands/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /statistic/management/commands/_private.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | web: gunicorn config.wsgi 2 | clock: python clock.py -------------------------------------------------------------------------------- /auth/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Create your models here. 4 | -------------------------------------------------------------------------------- /auth/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /api/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class ApiConfig(AppConfig): 5 | name = 'api' 6 | -------------------------------------------------------------------------------- /auth/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class AuthConfig(AppConfig): 5 | name = 'auth' 6 | -------------------------------------------------------------------------------- /auth/__pycache__/urls.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/auth/__pycache__/urls.cpython-39.pyc -------------------------------------------------------------------------------- /auth/__pycache__/views.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/auth/__pycache__/views.cpython-39.pyc -------------------------------------------------------------------------------- /auth/__pycache__/__init__.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/auth/__pycache__/__init__.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class StatisticConfig(AppConfig): 5 | name = 'statistic' 6 | -------------------------------------------------------------------------------- /auth/__pycache__/serializers.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/auth/__pycache__/serializers.cpython-39.pyc -------------------------------------------------------------------------------- /api/migrations/__pycache__/__init__.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/api/migrations/__pycache__/__init__.cpython-39.pyc -------------------------------------------------------------------------------- /api/migrations/__pycache__/0001_initial.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/api/migrations/__pycache__/0001_initial.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/management/__pycache__/__init__.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/management/__pycache__/__init__.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/migrations/__pycache__/__init__.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/migrations/__pycache__/__init__.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/migrations/__pycache__/0001_initial.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/migrations/__pycache__/0001_initial.cpython-39.pyc -------------------------------------------------------------------------------- /api/migrations/__pycache__/0002_auto_20210707_1851.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/api/migrations/__pycache__/0002_auto_20210707_1851.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/management/commands/__pycache__/__init__.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/management/commands/__pycache__/__init__.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/management/commands/__pycache__/monthly_report.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/management/commands/__pycache__/monthly_report.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/migrations/__pycache__/0002_auto_20210707_2130.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/migrations/__pycache__/0002_auto_20210707_2130.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/migrations/__pycache__/0003_auto_20210708_1549.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/migrations/__pycache__/0003_auto_20210708_1549.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/migrations/__pycache__/0004_auto_20210710_1343.cpython-39.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/F4R4N/movie-quote/HEAD/statistic/migrations/__pycache__/0004_auto_20210710_1343.cpython-39.pyc -------------------------------------------------------------------------------- /statistic/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from .models import Visit 3 | 4 | 5 | @admin.register(Visit) 6 | class VisitAdmin(admin.ModelAdmin): 7 | list_display = ("date", "visits", "visitors") 8 | -------------------------------------------------------------------------------- /api/utils.py: -------------------------------------------------------------------------------- 1 | from rest_framework.permissions import BasePermission, SAFE_METHODS 2 | 3 | 4 | class IsAdminOrReadOnly(BasePermission): 5 | def has_permission(self, request, view): 6 | if request.method in SAFE_METHODS: 7 | return True 8 | else: 9 | return request.user.is_staff 10 | -------------------------------------------------------------------------------- /statistic/serializers.py: -------------------------------------------------------------------------------- 1 | from rest_framework import serializers 2 | from .models import Visit 3 | 4 | 5 | class VisitByMonthSerializer(serializers.ModelSerializer): 6 | """Used in VisitorsViewByMonth view""" 7 | class Meta: 8 | model = Visit 9 | fields = ("date", "visitors", ) 10 | -------------------------------------------------------------------------------- /statistic/management/commands/monthly_report.py: -------------------------------------------------------------------------------- 1 | from django.core.management.base import BaseCommand 2 | from statistic.report import monthly_report 3 | 4 | 5 | class Command(BaseCommand): 6 | help = "Send month's report to admin's email address" 7 | 8 | def handle(self, *args, **options): 9 | monthly_report() 10 | -------------------------------------------------------------------------------- /auth/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import path 2 | from .views import LogoutView, UserLoginView 3 | from rest_framework_simplejwt.views import TokenRefreshView 4 | app_name = "auth" 5 | urlpatterns = [ 6 | path('login/', UserLoginView.as_view(), name='auth_login'), 7 | path('login/refresh/', TokenRefreshView.as_view(), name='auth_refresh'), 8 | path('logout/', LogoutView.as_view(), name='auth_logout'), 9 | ] 10 | -------------------------------------------------------------------------------- /statistic/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | 4 | class Visit(models.Model): 5 | visits = models.PositiveIntegerField(default=0) 6 | date = models.DateField(auto_now_add=True, unique=True) # deployment 7 | visitors = models.JSONField(blank=True, null=True) 8 | # date = models.DateField(unique=True) # development 9 | 10 | def __str__(self): 11 | return "visits: '{0}', date: '{1}'".format(str(self.visits), str(self.date)) 12 | -------------------------------------------------------------------------------- /config/asgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | ASGI config for config project. 3 | 4 | It exposes the ASGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.asgi import get_asgi_application 13 | 14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings') 15 | 16 | application = get_asgi_application() 17 | -------------------------------------------------------------------------------- /config/wsgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | WSGI config for config project. 3 | 4 | It exposes the WSGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.wsgi import get_wsgi_application 13 | 14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings') 15 | 16 | application = get_wsgi_application() 17 | -------------------------------------------------------------------------------- /clock.py: -------------------------------------------------------------------------------- 1 | from apscheduler.schedulers.blocking import BlockingScheduler 2 | from django.core.management import call_command 3 | import os 4 | import django 5 | 6 | 7 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings') 8 | django.setup() 9 | 10 | 11 | def send_report(): 12 | call_command("monthly_report") 13 | 14 | 15 | sched = BlockingScheduler() 16 | 17 | sched.add_job(send_report, "cron", year="*", month="*", day="*") 18 | 19 | sched.start() 20 | -------------------------------------------------------------------------------- /statistic/migrations/0002_auto_20210707_2130.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.1.7 on 2021-07-07 17:00 2 | 3 | from django.db import migrations 4 | 5 | 6 | class Migration(migrations.Migration): 7 | 8 | dependencies = [ 9 | ('statistic', '0001_initial'), 10 | ] 11 | 12 | operations = [ 13 | migrations.RenameField( 14 | model_name='visit', 15 | old_name='ips', 16 | new_name='visitors', 17 | ), 18 | ] 19 | -------------------------------------------------------------------------------- /statistic/migrations/0003_auto_20210708_1549.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.1.7 on 2021-07-08 11:19 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | class Migration(migrations.Migration): 7 | 8 | dependencies = [ 9 | ('statistic', '0002_auto_20210707_2130'), 10 | ] 11 | 12 | operations = [ 13 | migrations.AlterField( 14 | model_name='visit', 15 | name='date', 16 | field=models.DateField(unique=True), 17 | ), 18 | ] 19 | -------------------------------------------------------------------------------- /statistic/migrations/0004_auto_20210710_1343.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.1.7 on 2021-07-10 09:13 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | class Migration(migrations.Migration): 7 | 8 | dependencies = [ 9 | ('statistic', '0003_auto_20210708_1549'), 10 | ] 11 | 12 | operations = [ 13 | migrations.AlterField( 14 | model_name='visit', 15 | name='date', 16 | field=models.DateField(auto_now_add=True, unique=True), 17 | ), 18 | ] 19 | -------------------------------------------------------------------------------- /env.cmd: -------------------------------------------------------------------------------- 1 | :: this is a sample of environment variable use for deployment run "cmd /C env.cmd" to activate 2 | SET CONFIG_SECRET_KEY=secret_key 3 | SET CONFIG_DEBUG=0 4 | SET CONFIG_SECURE_SSL_REDIRECT=1 5 | SET CONFIG_SECURE_PROXY_SSL_HEADER=HTTP_X_FORWARDED_PROTO, https 6 | SET CONFIG_ALLOWED_HOSTS=127.0.0.1, localhost 7 | SET DB=db_name 8 | SET DB_USER=db_user 9 | SET DB_PASSWORD=db_password 10 | SET DB_HOST=db_hostname 11 | SET DB_PORT=db_port 12 | SET IPSTACK_ACCESS_KEY=your_access_key 13 | echo "all environment variables are set" 14 | -------------------------------------------------------------------------------- /api/migrations/0002_auto_20210707_1851.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.1.7 on 2021-07-07 14:21 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | class Migration(migrations.Migration): 7 | 8 | dependencies = [ 9 | ('api', '0001_initial'), 10 | ] 11 | 12 | operations = [ 13 | migrations.AlterField( 14 | model_name='quote', 15 | name='contain_adult_lang', 16 | field=models.BooleanField(default=False, verbose_name='Contain adult language'), 17 | ), 18 | ] 19 | -------------------------------------------------------------------------------- /env.sh: -------------------------------------------------------------------------------- 1 | # this is a sample of environment variable use for deployment run "source env.sh" to activate 2 | export CONFIG_SECRET_KEY=secret_key 3 | export CONFIG_DEBUG=0 4 | export CONFIG_SECURE_SSL_REDIRECT=1 5 | export CONFIG_SECURE_PROXY_SSL_HEADER=HTTP_X_FORWARDED_PROTO, https 6 | export CONFIG_ALLOWED_HOSTS=127.0.0.1, localhost 7 | export DB=db_name 8 | export DB_USER=db_user 9 | export DB_PASSWORD=db_password 10 | export DB_HOST=db_hostname 11 | export DB_PORT=db_port 12 | export IPSTACK_ACCESS_KEY=your_access_key 13 | echo "all environment variables are set" 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # python virtual environment 2 | venv/ 3 | # python __pycache__ directories 4 | api/__pycache__/ 5 | auth/__pycache__/ 6 | config/__pycache__/ 7 | statistic/__pycache__/ 8 | # test databases 9 | *.sqlite3 10 | # test configs 11 | config/config.py 12 | # django test dumpdata's 13 | Backups/ 14 | test-* 15 | # saved git diff in file 16 | diff* 17 | # vscode editor 18 | movie-quote.code-workspace 19 | .vscode/ 20 | # env variables 21 | local-env.cmd 22 | # log files 23 | log* 24 | Procfile 25 | runtime.txt 26 | data.json 27 | 28 | *.pyc 29 | migrations/ 30 | .env -------------------------------------------------------------------------------- /statistic/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import path 2 | from .views import ( 3 | VisitsYearView, VisitsMonthView, VisitorsViewByDay, VisitorsViewByMonth 4 | ) 5 | 6 | app_name = "statistic" 7 | 8 | urlpatterns = [ 9 | path("admin/statistic/visits//", VisitsYearView.as_view()), 10 | path( 11 | "admin/statistic/visits///", 12 | VisitsMonthView.as_view()), 13 | 14 | path( 15 | "admin/statistic/visitors////", 16 | VisitorsViewByDay.as_view() 17 | ), 18 | 19 | path( 20 | "admin/statistic/visitors///", 21 | VisitorsViewByMonth.as_view() 22 | ), 23 | 24 | ] 25 | -------------------------------------------------------------------------------- /templates/email.txt: -------------------------------------------------------------------------------- 1 | Hi Dear {{ username }}, 2 | this is 'Movie Quote' app monthly report. 3 | report for {{ year }} / {{ month }} 4 | 5 | Total Views in this month: {{ total_views }} 6 | 7 | {% for date, visits_count in views.items %} 8 | {{ date }} : {{ visits_count }} 9 | {% endfor %} 10 | {% for visits in visitors_info %}=================================== 11 | Date: {{ visits.date }} 12 | Total Visits: {{ visits.visits }} 13 | 14 | Visitors: 15 | --------------------{% for visit, obj in visits.visitors.items %} 16 | IP: {{ visit }} 17 | Location: {{ obj.location.country }}, {{ obj.location.region }}, {{ obj.location.city }} 18 | Visits Count: {{ obj.views }} 19 | --------------------{% endfor %} 20 | {% endfor %} -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | """Django's command-line utility for administrative tasks.""" 3 | import os 4 | import sys 5 | 6 | 7 | def main(): 8 | """Run administrative tasks.""" 9 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings') 10 | try: 11 | from django.core.management import execute_from_command_line 12 | except ImportError as exc: 13 | raise ImportError( 14 | "Couldn't import Django. Are you sure it's installed and " 15 | "available on your PYTHONPATH environment variable? Did you " 16 | "forget to activate a virtual environment?" 17 | ) from exc 18 | execute_from_command_line(sys.argv) 19 | 20 | 21 | if __name__ == '__main__': 22 | main() 23 | -------------------------------------------------------------------------------- /statistic/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.1.7 on 2021-07-05 07:26 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | class Migration(migrations.Migration): 7 | 8 | initial = True 9 | 10 | dependencies = [ 11 | ] 12 | 13 | operations = [ 14 | migrations.CreateModel( 15 | name='Visit', 16 | fields=[ 17 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), 18 | ('visits', models.PositiveIntegerField(default=0)), 19 | ('date', models.DateField(auto_now=True, unique=True)), 20 | ('ips', models.JSONField(blank=True, null=True)), 21 | ], 22 | ), 23 | ] 24 | -------------------------------------------------------------------------------- /auth/serializers.py: -------------------------------------------------------------------------------- 1 | from rest_framework_simplejwt.tokens import RefreshToken 2 | from rest_framework_simplejwt.serializers import TokenObtainSerializer 3 | 4 | 5 | class UserLoginSerializer(TokenObtainSerializer): 6 | @classmethod 7 | def get_token(cls, user): 8 | return RefreshToken.for_user(user) 9 | 10 | def validate(self, attrs): 11 | data = super().validate(attrs) 12 | 13 | refresh = self.get_token(self.user) 14 | 15 | data['tokens'] = { 16 | 'refresh': str(refresh), 17 | "access": str(refresh.access_token) 18 | } 19 | 20 | data['user'] = { 21 | 'username': self.user.username, 22 | 'email': self.user.email, 23 | 'first_name': self.user.first_name, 24 | 'last_name': self.user.last_name 25 | } 26 | 27 | return data 28 | -------------------------------------------------------------------------------- /api/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from .models import Quote, Role, Show, Ticket 3 | 4 | 5 | @admin.register(Quote) 6 | class QuoteAdmin(admin.ModelAdmin): 7 | list_display = ('key', "contain_adult_lang", 'quote', 'show', 'role', "id", ) 8 | list_editable = ("contain_adult_lang", "quote") 9 | 10 | 11 | @admin.register(Ticket) 12 | class TicketAdmin(admin.ModelAdmin): 13 | list_display = ('key', "contain_adult_lang", 'quote', 'show', 'role', "id", ) 14 | list_editable = ("contain_adult_lang", "quote") 15 | 16 | 17 | @admin.register(Show) 18 | class ShowAdmin(admin.ModelAdmin): 19 | list_display = ("name", "slug", "id") 20 | prepopulated_fields = {"slug": ("name", )} 21 | 22 | 23 | @admin.register(Role) 24 | class RoleAdmin(admin.ModelAdmin): 25 | list_display = ('name', 'slug', "id") 26 | prepopulated_fields = {"slug": ("name", )} 27 | -------------------------------------------------------------------------------- /config/urls.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from django.urls import path, include 3 | 4 | from rest_framework import permissions 5 | from drf_yasg import openapi 6 | from drf_yasg.views import get_schema_view 7 | 8 | schema_view = get_schema_view( 9 | openapi.Info( 10 | title="Movie Quote Api Documentation", 11 | default_version='v1', 12 | description="auto created documentation by drf_yasg.", 13 | contact=openapi.Contact(email="farantgh@gmail.com"), 14 | license=openapi.License(name="BSD License"), 15 | ), 16 | public=True, 17 | permission_classes=(permissions.AllowAny,), 18 | ) 19 | 20 | 21 | urlpatterns = [ 22 | path('admin/', admin.site.urls), 23 | path('', include('api.urls')), 24 | path("v1/auth/", include("auth.urls")), 25 | path("v1/", include("statistic.urls")), 26 | path('doc/', schema_view.with_ui( 27 | 'swagger', cache_timeout=0), name='schema_swagger_ui') 28 | 29 | ] 30 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | amqp==5.0.6 2 | APScheduler==3.7.0 3 | asgiref==3.3.1 4 | billiard==3.6.4.0 5 | certifi==2020.12.5 6 | chardet==4.0.0 7 | click==7.1.2 8 | click-didyoumean==0.0.3 9 | click-plugins==1.1.1 10 | click-repl==0.2.0 11 | coreapi==2.3.3 12 | coreschema==0.0.4 13 | Django==3.1.7 14 | django-cors-headers==3.7.0 15 | djangorestframework==3.12.2 16 | djangorestframework-simplejwt==4.6.0 17 | drf-yasg==1.20.0 18 | flake8==3.9.2 19 | gunicorn==20.1.0 20 | idna==2.10 21 | inflection==0.5.1 22 | itypes==1.2.0 23 | Jinja2==2.11.3 24 | kombu==5.1.0 25 | MarkupSafe==1.1.1 26 | mccabe==0.6.1 27 | packaging==20.9 28 | prompt-toolkit==3.0.19 29 | psycopg2 30 | pycodestyle==2.7.0 31 | pyflakes==2.3.1 32 | PyJWT==1.7.1 33 | pyparsing==2.4.7 34 | pytz==2021.1 35 | requests==2.25.1 36 | ruamel.yaml==0.16.13 37 | six==1.16.0 38 | sqlparse==0.4.1 39 | tzlocal==2.1 40 | uritemplate==3.0.1 41 | urllib3==1.26.4 42 | vine==5.0.0 43 | wcwidth==0.2.5 44 | -------------------------------------------------------------------------------- /auth/views.py: -------------------------------------------------------------------------------- 1 | from rest_framework.permissions import AllowAny, IsAuthenticated 2 | from rest_framework.views import APIView 3 | from rest_framework import status 4 | from rest_framework.response import Response 5 | from .serializers import UserLoginSerializer 6 | from rest_framework_simplejwt.views import TokenViewBase 7 | from rest_framework_simplejwt.tokens import RefreshToken 8 | 9 | 10 | class UserLoginView(TokenViewBase): 11 | serializer_class = UserLoginSerializer 12 | permission_classes = (AllowAny, ) 13 | 14 | 15 | class LogoutView(APIView): 16 | permission_classes = (IsAuthenticated,) 17 | 18 | def post(self, request): 19 | try: 20 | refresh_token = request.data["refresh_token"] 21 | token = RefreshToken(refresh_token) 22 | token.blacklist() 23 | 24 | return Response( 25 | status=status.HTTP_205_RESET_CONTENT, 26 | data={'detail': "logged out"}) 27 | 28 | except Exception: 29 | return Response( 30 | status=status.HTTP_400_BAD_REQUEST, 31 | data={"detail": "refresh_token is not valid"}) 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # movie-quote 2 | 3 | a api made with django rest framework serve movie and series quotes. you can find the api [Here](https://movie-quote-api.herokuapp.com). 4 | 5 | ## Run locally 6 | 7 | ### Linux 8 | 9 | 1. `git clone https://github.com/F4R4N/movie-quote.git` 10 | 2. `apt install python3` 11 | 3. `cd movie-quote` 12 | 4. `python3 -m venv venv` 13 | 5. `source venv/bin/activate` 14 | 6. `mv sample.config.py config.py` (change settings based on your usage) 15 | 7. `python3 manage.py migrate` 16 | 8. `python3 manage.py runserver` 17 | 9. open browser in 127.0.0.1:8000 18 | 19 | ## Usage 20 | 21 | use the following path's to get the quotes. 22 | 23 | ### `/v1/quote/` 24 | 25 | get a random quote each time, from all quotes. 26 | 27 | ### `/v1/quote?censored` 28 | 29 | don't show quotes which contain adult language. 30 | 31 | ### `/v1/shows/` 32 | 33 | you can get a random quote from the desired show. you can find list of show's slug in . 34 | 35 | ### `/v1/shows/` 36 | 37 | get list of available shows slugs. 38 | 39 | ## make this repo better 40 | 41 | feel free to open `issue` or `pull request` I am trying to make repo better and this will help me. 42 | 43 | ## deployment 44 | 45 | `main` branch of this repository will automatically deploy on [Heroku](https://www.heroku.com). 46 | -------------------------------------------------------------------------------- /api/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import path, re_path 2 | from .views import ( 3 | MainPage, SpecificShowQuotes, AdminQuoteView, AdminDeleteUserView, 4 | AdminEditAndDeleteQuoteView, AdminUserView, AdminEditUserView, UserQuoteView, 5 | AdminEditShowView, AdminEditRoleView, AllShowsView, AdminAllRolesView, ) 6 | 7 | app_name = 'api' 8 | 9 | urlpatterns = [ 10 | path('', MainPage.as_view(), name="main_page"), 11 | path("v1/quote/", UserQuoteView.as_view(), name="random_quote"), 12 | re_path( 13 | r"^v1/quote/(?P)/$", UserQuoteView.as_view(), 14 | name="random_censored_quote"), 15 | 16 | path( 17 | 'v1/shows//', SpecificShowQuotes.as_view(), name="show_quote"), 18 | path('v1/shows/', AllShowsView.as_view(), name="all_shows"), 19 | 20 | path( 21 | "v1/admin/quote/", AdminQuoteView.as_view(), name="admin_create_list_quote"), 22 | path( 23 | "v1/admin/quote//", 24 | AdminEditAndDeleteQuoteView.as_view(), name="admin_edit_delete_quote"), 25 | 26 | path( 27 | "v1/admin/show/edit//", 28 | AdminEditShowView.as_view(), name="admin_edit_show"), 29 | path("v1/admin/shows/", AllShowsView.as_view(), name="admin_all_shows"), 30 | 31 | path( 32 | "v1/admin/role/edit//", 33 | AdminEditRoleView.as_view(), name="admin_edit_role"), 34 | path("v1/admin/roles/", AdminAllRolesView.as_view(), name="admin_all_roles"), 35 | 36 | path( 37 | "v1/admin/user/", AdminUserView.as_view(), name="admin_create_list_user"), 38 | path( 39 | "v1/admin/user/edit//", 40 | AdminEditUserView.as_view(), name="admin_edit_user"), 41 | path( 42 | "v1/admin/user/delete//", 43 | AdminDeleteUserView.as_view(), name="admin_delete_user"), 44 | 45 | ] 46 | -------------------------------------------------------------------------------- /api/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | import random 3 | import string 4 | from django.utils.text import slugify 5 | 6 | 7 | def random_key(): 8 | all_digits = list(string.digits) 9 | random_key = "" 10 | return random_key.join(random.sample(all_digits, 10)) 11 | 12 | 13 | class RoleAndShowBase(models.Model): 14 | name = models.CharField(max_length=100, unique=True) 15 | slug = models.SlugField(max_length=100) 16 | 17 | class Meta: 18 | abstract = True 19 | 20 | 21 | class Show(RoleAndShowBase): 22 | def save(self, *args, **kwargs): # Slugify 23 | self.slug = slugify(self.name) 24 | super(Show, self).save(*args, **kwargs) 25 | 26 | def __str__(self): 27 | return self.name 28 | 29 | 30 | class Role(RoleAndShowBase): 31 | 32 | def save(self, *args, **kwargs): 33 | self.slug = slugify(self.name) 34 | super(Role, self).save(*args, **kwargs) 35 | 36 | def __str__(self): 37 | return self.name 38 | 39 | 40 | class QuoteBaseClass(models.Model): 41 | key = models.CharField(default=random_key, max_length=10, unique=True) 42 | quote = models.CharField(max_length=500, unique=True) 43 | 44 | contain_adult_lang = models.BooleanField( 45 | verbose_name="Contain adult language", default=False) 46 | 47 | class Meta: 48 | abstract = True 49 | 50 | 51 | class Quote(QuoteBaseClass): 52 | show = models.ForeignKey( 53 | Show, on_delete=models.DO_NOTHING) 54 | role = models.ForeignKey( 55 | Role, on_delete=models.DO_NOTHING) 56 | 57 | def __str__(self): 58 | return str(self.key) 59 | 60 | 61 | class Ticket(QuoteBaseClass): 62 | SUGGESTION_TYPE = ( 63 | ("edit", "Edit"), 64 | ("add", "Add"), 65 | ) 66 | sug_type = models.CharField(max_length=4, choices=SUGGESTION_TYPE) 67 | show = models.CharField(max_length=100) 68 | role = models.CharField(max_length=100) 69 | 70 | def __str__(self) -> str: 71 | return str(self.key) 72 | -------------------------------------------------------------------------------- /api/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 3.1.7 on 2021-07-05 07:34 2 | 3 | import api.models 4 | from django.db import migrations, models 5 | import django.db.models.deletion 6 | 7 | 8 | class Migration(migrations.Migration): 9 | 10 | initial = True 11 | 12 | dependencies = [ 13 | ] 14 | 15 | operations = [ 16 | migrations.CreateModel( 17 | name='Role', 18 | fields=[ 19 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), 20 | ('name', models.CharField(max_length=100, unique=True)), 21 | ('slug', models.SlugField(max_length=100)), 22 | ], 23 | ), 24 | migrations.CreateModel( 25 | name='Show', 26 | fields=[ 27 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), 28 | ('name', models.CharField(max_length=100, unique=True)), 29 | ('slug', models.SlugField(max_length=100)), 30 | ], 31 | ), 32 | migrations.CreateModel( 33 | name='Quote', 34 | fields=[ 35 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), 36 | ('key', models.CharField(default=api.models.random_key, max_length=10, unique=True)), 37 | ('quote', models.CharField(max_length=500, unique=True)), 38 | ('contain_adult_lang', models.BooleanField(default=False)), 39 | ('role', models.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, related_name='role', to='api.role')), 40 | ('show', models.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, related_name='show', to='api.show')), 41 | ], 42 | ), 43 | ] 44 | -------------------------------------------------------------------------------- /statistic/report.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | from statistic.models import Visit 3 | from statistic.utils import views_in_month 4 | from django.template.loader import get_template 5 | from django.contrib.auth.models import User 6 | from django.core.mail import EmailMultiAlternatives 7 | 8 | 9 | def monthly_report(): 10 | """Send email report to active users with superuser and staff status, 11 | report contain month visits and visitors information's""" 12 | cur_year = datetime.now().year 13 | cur_month = datetime.now().month 14 | visitors = Visit.objects.filter( 15 | date__year=cur_year, date__month=cur_month).order_by("date__day") 16 | 17 | _, views, total_views = views_in_month(cur_year, cur_month) 18 | 19 | # send html email 20 | plaintext = get_template('email.txt') 21 | html = get_template('email.html') 22 | # admin users queryset 23 | admins = User.objects.filter( 24 | is_staff=True, is_active=True, is_superuser=True, ) 25 | 26 | # context that we want to use in email template 27 | context = { 28 | "year": cur_year, 29 | "month": cur_month, 30 | "visitors_info": visitors, 31 | "views": views, 32 | "total_views": total_views, 33 | } 34 | # email subject 35 | subject = "Movie-Quote Monthly Report" 36 | for admin in admins: 37 | context["username"] = admin.username 38 | # render templates separately for each admin user 39 | text_context = plaintext.render(context) 40 | html_context = html.render(context) 41 | msg = EmailMultiAlternatives( 42 | subject=subject, 43 | body=text_context, 44 | from_email="pythontestsendingemail@gmail.com", to=[admin.email] 45 | ) 46 | # attach html to plain text email 47 | msg.attach_alternative(html_context, "text/html") 48 | try: 49 | msg.send(fail_silently=False) 50 | except Exception as ex: 51 | raise Exception( 52 | "not able to send Email." 53 | " its probably smtp security modules blocking this action" 54 | ) from ex 55 | 56 | log = "[{}] Report sent".format( 57 | datetime.now().strftime("%Y-%m-%d-%H:%M:%S.%f") 58 | ) 59 | print(log) 60 | -------------------------------------------------------------------------------- /statistic/views.py: -------------------------------------------------------------------------------- 1 | from django.utils import timezone 2 | from .models import Visit 3 | from django.shortcuts import get_object_or_404 4 | from rest_framework.views import APIView 5 | from rest_framework.response import Response 6 | from rest_framework import permissions, status 7 | import calendar 8 | from .serializers import VisitByMonthSerializer 9 | from .utils import views_in_month 10 | 11 | 12 | class VisitsYearView(APIView): 13 | permission_classes = (permissions.IsAdminUser, ) 14 | 15 | def get(self, request, year, format=None): 16 | cur_year = timezone.now().year 17 | if year == cur_year: 18 | months = timezone.now().month 19 | elif year < cur_year: 20 | months = 12 21 | elif year > cur_year: 22 | return Response( 23 | status=status.HTTP_400_BAD_REQUEST, 24 | data={"detail": "given year not reached yet."}) 25 | 26 | cur_month_visits = {} 27 | for month in range(1, months + 1): 28 | if month not in cur_month_visits.keys(): 29 | cur_month_visits[calendar.month_name[month]] = 0 30 | year_visit = list( 31 | Visit.objects.filter( 32 | date__year=year, date__month=month).values_list("visits", flat=True)) 33 | 34 | cur_month_visits[calendar.month_name[month]] += sum(year_visit) 35 | 36 | return Response(status=status.HTTP_200_OK, data=cur_month_visits) 37 | 38 | 39 | class VisitsMonthView(APIView): 40 | permission_classes = (permissions.IsAdminUser, ) 41 | 42 | def get(self, request, year, month, foramt=None): 43 | status, data, total_views = views_in_month(year, month) 44 | return Response(status=status, data=data) 45 | 46 | 47 | class VisitorsViewByDay(APIView): 48 | permission_classes = (permissions.IsAdminUser, ) 49 | 50 | def get(self, request, year, month, day, format=None): 51 | visit = get_object_or_404( 52 | Visit, date__year=year, date__month=month, date__day=day) 53 | 54 | return Response(status=status.HTTP_200_OK, data=visit.visitors) 55 | 56 | 57 | class VisitorsViewByMonth(APIView): 58 | 59 | permission_classes = (permissions.IsAdminUser, ) 60 | 61 | def get(self, request, year, month, format=None): 62 | visits = Visit.objects.filter(date__year=year, date__month=month) 63 | serializer = VisitByMonthSerializer(instance=visits, many=True) 64 | return Response(status=status.HTTP_200_OK, data=serializer.data) 65 | -------------------------------------------------------------------------------- /statistic/utils.py: -------------------------------------------------------------------------------- 1 | from django.utils import timezone 2 | from rest_framework import status 3 | from .models import Visit 4 | import requests 5 | from django.conf import settings 6 | import calendar 7 | 8 | UNKNOWN = "unknown" 9 | 10 | 11 | def add_or_create_visit(ip: str): 12 | """Create Visit object if not already exists""" 13 | try: 14 | visit = Visit.objects.get(date=timezone.now().date()) 15 | visit.visits += 1 16 | if ip in visit.visitors: 17 | visit.visitors[ip]["views"] += 1 18 | else: 19 | visit.visitors[ip] = {"views": 1} 20 | visit.visitors[ip]["location"] = get_user_country_by_ip(ip) 21 | visit.save() 22 | except Visit.DoesNotExist: 23 | visit = Visit.objects.create( 24 | visits=1, visitors={ 25 | ip: {"views": 1, "location": get_user_country_by_ip(ip), } 26 | } 27 | ) 28 | 29 | 30 | def get_client_ip(request) -> str: 31 | """Extract client IP address from passed "request" object""" 32 | x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR') 33 | if x_forwarded_for: 34 | ip = x_forwarded_for.split(',')[0] 35 | else: 36 | ip = request.META.get('REMOTE_ADDR') 37 | return ip 38 | 39 | 40 | def get_user_country_by_ip(ip: str) -> dict: 41 | """Send request to "ipstack" api and get user location by its IP address""" 42 | try: 43 | api_key = settings.IPSTACK_ACCESS_KEY 44 | url = f"http://api.ipstack.com/{ip}?access_key={api_key}" 45 | response = requests.get(url).json() 46 | return { 47 | "country": response["country_name"], 48 | "region": response["region_name"], 49 | "city": response["city"] 50 | } 51 | except KeyError: 52 | return { 53 | "country": UNKNOWN, 54 | "region": UNKNOWN, 55 | "city": UNKNOWN 56 | } 57 | 58 | 59 | def views_in_month(year: int, month: int) -> tuple: 60 | """Return total views and visits in current month""" 61 | cur_year = timezone.now().year 62 | cur_month = timezone.now().month 63 | cur_day = timezone.now().day 64 | total_visits = 0 65 | if year == cur_year: 66 | if month > cur_month: 67 | return ( 68 | status.HTTP_400_BAD_REQUEST, 69 | {"detail": "requested month not reached yet."}) 70 | 71 | elif year > cur_year: 72 | return ( 73 | status.HTTP_400_BAD_REQUEST, 74 | {"detail": "requested year not reached yet."}) 75 | 76 | n, day_in_cur_month = calendar.monthrange(year, month) 77 | visits_in_month = {} 78 | if month == cur_month: 79 | day_in_cur_month = cur_day 80 | for day in range(1, day_in_cur_month + 1): 81 | visits_in_month["{0}-{1}-{2}".format(year, month, day)] = 0 82 | try: 83 | month_visit = Visit.objects.get( 84 | date__year=year, date__month=month, date__day=day) 85 | 86 | visits_in_month["{0}-{1}-{2}".format(year, month, day)] = month_visit.visits 87 | total_visits += month_visit.visits 88 | except Visit.DoesNotExist: 89 | pass 90 | return (status.HTTP_200_OK, visits_in_month, total_visits) 91 | -------------------------------------------------------------------------------- /templates/email.html: -------------------------------------------------------------------------------- 1 | 2 |
3 |

Hi Dear {{ username }},

4 |

this is 'Movie Quote' app monthly report.

5 |

report for {{ year }} / {{ month }}

6 |

Total Views in this month: {{ total_views }}

7 |
8 | 9 | 10 | 11 | 12 | 13 | 14 | {% for date, visits_count in views.items %} 15 | 16 | 17 | 18 | 19 | 20 | {% endfor %} 21 |
Visits In Month Days
DateVisit(s)
{{ date }}{{ visits_count }}
22 |
23 |

Visitors Info

24 |
25 | {% for visits in visitors_info %} 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | {% for visit, obj in visits.visitors.items %} 39 | 40 | 41 | 42 | 43 | 44 | 45 | {% endfor %} 46 |
{{ visits.date }}
Visitors
IPLocationVisits
{{ visit }}{{ obj.location.country }}, {{ obj.location.region }}, {{ obj.location.city }}{{ obj.views }}
47 |
48 | {% endfor %} 49 |
50 | -------------------------------------------------------------------------------- /api/serializers.py: -------------------------------------------------------------------------------- 1 | from rest_framework import serializers 2 | from .models import Quote, Role, Show 3 | from rest_framework.validators import UniqueValidator 4 | from django.contrib.auth.password_validation import validate_password 5 | from django.contrib.auth.models import User 6 | 7 | 8 | class QuoteSerializer(serializers.ModelSerializer): 9 | class Meta: 10 | model = Quote 11 | fields = ("quote", 'role', "show", "contain_adult_lang") 12 | role = serializers.CharField(source="role.name") 13 | show = serializers.CharField(source="show.name") 14 | 15 | 16 | class AdminAddUserSerializer(serializers.ModelSerializer): 17 | username = serializers.CharField( 18 | required=True, validators=[UniqueValidator(queryset=User.objects.all())]) 19 | 20 | email = serializers.EmailField( 21 | required=True, validators=[UniqueValidator(queryset=User.objects.all())]) 22 | 23 | password1 = serializers.CharField( 24 | write_only=True, required=True, validators=[validate_password]) 25 | 26 | password2 = serializers.CharField( 27 | write_only=True, required=True, validators=[validate_password]) 28 | 29 | class Meta: 30 | model = User 31 | fields = ( 32 | "id", "username", "first_name", 'last_name', "email", "password2", 33 | "password1", "is_superuser", "is_active", "is_staff") 34 | 35 | extra_kwargs = { 36 | "first_name": {"required": True}, 37 | "last_name": {"required": True} 38 | } 39 | 40 | def validate(self, attrs): 41 | main_superuser_username = User.objects.filter( 42 | is_superuser=True, 43 | is_staff=True, 44 | is_active=True 45 | ).first().username 46 | if self.context['request'].user.username != main_superuser_username: 47 | raise serializers.ValidationError( 48 | { 49 | "detail": "you don't have permission to perform this action", 50 | "hint": f"contact user '{main_superuser_username}'"}) 51 | 52 | if attrs['password2'] != attrs["password1"]: 53 | raise serializers.ValidationError( 54 | {"password": "password fields don't match"}) 55 | return attrs 56 | 57 | def create(self, validated_data): 58 | user = User.objects.create( 59 | username=validated_data['username'], 60 | email=validated_data['email'], 61 | first_name=validated_data['first_name'], 62 | last_name=validated_data['last_name'], 63 | is_active=validated_data['is_active'], 64 | is_superuser=validated_data['is_superuser'] 65 | ) 66 | user.set_password(validated_data["password1"]) 67 | user.save() 68 | user.user_permissions.clear() 69 | return user 70 | 71 | 72 | class ShowSerializer(serializers.ModelSerializer): 73 | class Meta: 74 | model = Show 75 | fields = ("name", "slug") 76 | read_only_fields = ("slug", ) 77 | 78 | 79 | class RoleSerializer(serializers.ModelSerializer): 80 | class Meta: 81 | model = Role 82 | fields = ("name", "slug") 83 | read_only_fields = ("slug", ) 84 | 85 | 86 | class AdminQuoteSerializer(serializers.ModelSerializer): 87 | role = serializers.CharField(required=True) 88 | show = serializers.CharField(required=True) 89 | 90 | class Meta: 91 | model = Quote 92 | fields = ("key", "quote", "role", "show", "contain_adult_lang") 93 | 94 | def create(self, validated_data): 95 | role_name = validated_data.get("role").title() 96 | show_name = validated_data.get("show").title() 97 | try: 98 | role = Role.objects.get(name=role_name) 99 | except Role.DoesNotExist: 100 | role = Role.objects.create(name=role_name) 101 | try: 102 | show = Show.objects.get(name=show_name) 103 | except Show.DoesNotExist: 104 | show = Show.objects.create(name=show_name) 105 | quote = Quote.objects.create( 106 | quote=validated_data['quote'], 107 | show=show, 108 | role=role, 109 | contain_adult_lang=validated_data["contain_adult_lang"], 110 | ) 111 | return quote 112 | -------------------------------------------------------------------------------- /config/dev-settings.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | from datetime import timedelta 3 | import os 4 | 5 | 6 | BASE_DIR = Path(__file__).resolve().parent.parent 7 | 8 | SECRET_KEY = "SECRET_KEY" 9 | DEBUG = True 10 | 11 | 12 | ALLOWED_HOSTS = [] 13 | 14 | INSTALLED_APPS = [ 15 | 'django.contrib.admin', 16 | 'django.contrib.auth', 17 | 'django.contrib.contenttypes', 18 | 'django.contrib.sessions', 19 | 'django.contrib.messages', 20 | 'django.contrib.staticfiles', 21 | 'api.apps.ApiConfig', 22 | 'statistic.apps.StatisticConfig', 23 | 'rest_framework', 24 | 'rest_framework.authtoken', 25 | 'rest_framework_simplejwt.token_blacklist', 26 | 'drf_yasg', 27 | 'corsheaders', 28 | 29 | ] 30 | 31 | MIDDLEWARE = [ 32 | 'django.middleware.security.SecurityMiddleware', 33 | 'corsheaders.middleware.CorsMiddleware', 34 | 'django.contrib.sessions.middleware.SessionMiddleware', 35 | 'django.middleware.common.CommonMiddleware', 36 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 37 | 'django.contrib.messages.middleware.MessageMiddleware', 38 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 39 | ] 40 | 41 | ROOT_URLCONF = 'config.urls' 42 | 43 | TEMPLATES = [ 44 | { 45 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 46 | 'DIRS': [os.path.join(BASE_DIR, 'templates')], 47 | 'APP_DIRS': True, 48 | 'OPTIONS': { 49 | 'context_processors': [ 50 | 'django.template.context_processors.debug', 51 | 'django.template.context_processors.request', 52 | 'django.contrib.auth.context_processors.auth', 53 | 'django.contrib.messages.context_processors.messages', 54 | ], 55 | }, 56 | }, 57 | ] 58 | 59 | WSGI_APPLICATION = 'config.wsgi.application' 60 | DATABASES = { 61 | 'default': { 62 | 'ENGINE': "django.db.backends.sqlite3", 63 | 'NAME': os.path.join(BASE_DIR, "db.sqlite3") 64 | } 65 | } 66 | PASSWORD_VALIDATOR = 'django.contrib.auth.password_validation.' 67 | AUTH_PASSWORD_VALIDATORS = [ 68 | { 69 | 'NAME': f'{PASSWORD_VALIDATOR}UserAttributeSimilarityValidator', 70 | }, 71 | { 72 | 'NAME': f'{PASSWORD_VALIDATOR}MinimumLengthValidator', 73 | }, 74 | { 75 | 'NAME': f'{PASSWORD_VALIDATOR}CommonPasswordValidator', 76 | }, 77 | { 78 | 'NAME': f'{PASSWORD_VALIDATOR}NumericPasswordValidator', 79 | }, 80 | ] 81 | 82 | LANGUAGE_CODE = 'en-us' 83 | 84 | TIME_ZONE = 'America/New_York' 85 | 86 | USE_I18N = True 87 | 88 | USE_L10N = True 89 | 90 | USE_TZ = True 91 | 92 | STATIC_URL = '/static/' 93 | MEDIA_URL = '/media/' 94 | MEDIA_ROOT = os.path.join(BASE_DIR, 'media/') 95 | STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles') 96 | STATICFILES_DIRS = ( 97 | os.path.join(BASE_DIR, 'static'), 98 | ) 99 | REST_FRAMEWORK = { 100 | 'TEST_REQUEST_DEFAULT_FORMAT': 'json', 101 | # 'DEFAULT_RENDERER_CLASSES': [ 102 | # 'rest_framework.renderers.JSONRenderer', 103 | # ], 104 | # 'DEFAULT_PARSER_CLASSES': [ 105 | # 'rest_framework.parsers.JSONParser', 106 | # ], 107 | 'DEFAULT_PERMISSION_CLASSES': [ 108 | 'rest_framework.permissions.IsAdminUser', 109 | ], 110 | 'DEFAULT_AUTHENTICATION_CLASSES': [ 111 | 'rest_framework_simplejwt.authentication.JWTAuthentication', 112 | ], 113 | } 114 | 115 | SIMPLE_JWT = { 116 | 'ACCESS_TOKEN_LIFETIME': timedelta(days=1), 117 | 'REFRESH_TOKEN_LIFETIME': timedelta(days=3), 118 | 'ROTATE_REFRESH_TOKENS': True, 119 | 'BLACKLIST_AFTER_ROTATION': True, 120 | } 121 | 122 | SWAGGER_SETTINGS = { 123 | 'USE_SESSION_AUTH': False, 124 | 'SECURITY_DEFINITIONS': { 125 | 'Bearer': { 126 | 'type': 'apiKey', 127 | 'name': 'Authorization', 128 | 'in': 'header' 129 | } 130 | } 131 | } 132 | CORS_ALLOW_ALL_ORIGINS = True 133 | IPSTACK_ACCESS_KEY = os.environ.get("IPSTACK_ACCESS_KEY") 134 | 135 | EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend' 136 | EMAIL_USE_TLS = True 137 | EMAIL_HOST = os.environ.get("EMAIL_SMTP") 138 | EMAIL_PORT = 587 139 | EMAIL_HOST_USER = os.environ.get("EMAIL_EMAIL") 140 | EMAIL_HOST_PASSWORD = os.environ.get("EMAIL_PASSWORD") 141 | -------------------------------------------------------------------------------- /config/settings.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | from datetime import timedelta 3 | import os 4 | 5 | 6 | BASE_DIR = Path(__file__).resolve().parent.parent 7 | 8 | SECRET_KEY = str(os.environ.get("CONFIG_SECRET_KEY")) 9 | 10 | DEBUG = bool(int(os.environ.get("CONFIG_DEBUG", 0))) 11 | 12 | ALLOWED_HOSTS = os.environ.get("CONFIG_ALLOWED_HOSTS", []).split(", ") 13 | 14 | 15 | INSTALLED_APPS = [ 16 | 'django.contrib.admin', 17 | 'django.contrib.auth', 18 | 'django.contrib.contenttypes', 19 | 'django.contrib.sessions', 20 | 'django.contrib.messages', 21 | 'django.contrib.staticfiles', 22 | 'api.apps.ApiConfig', 23 | 'statistic.apps.StatisticConfig', 24 | 'rest_framework', 25 | 'rest_framework.authtoken', 26 | 'rest_framework_simplejwt.token_blacklist', 27 | 'drf_yasg', 28 | 'corsheaders', 29 | 30 | ] 31 | 32 | MIDDLEWARE = [ 33 | 'django.middleware.security.SecurityMiddleware', 34 | 'corsheaders.middleware.CorsMiddleware', 35 | 'django.contrib.sessions.middleware.SessionMiddleware', 36 | 'django.middleware.common.CommonMiddleware', 37 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 38 | 'django.contrib.messages.middleware.MessageMiddleware', 39 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 40 | ] 41 | 42 | ROOT_URLCONF = 'config.urls' 43 | 44 | TEMPLATES = [ 45 | { 46 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 47 | # path to load email templates 48 | 'DIRS': [os.path.join(BASE_DIR, 'templates')], 49 | 'APP_DIRS': True, 50 | 'OPTIONS': { 51 | 'context_processors': [ 52 | 'django.template.context_processors.debug', 53 | 'django.template.context_processors.request', 54 | 'django.contrib.auth.context_processors.auth', 55 | 'django.contrib.messages.context_processors.messages', 56 | ], 57 | }, 58 | }, 59 | ] 60 | 61 | WSGI_APPLICATION = 'config.wsgi.application' 62 | # database configs 63 | DATABASES = { 64 | 'default': { 65 | 'ENGINE': "django.db.backends.mysql", 66 | "NAME": os.environ.get("DB_NAME"), 67 | "USER": os.environ.get("DB_USER"), 68 | "PASSWORD": os.environ.get("DB_PASSWORD"), 69 | "HOST": os.environ.get("DB_HOST"), 70 | "PORT": int(os.environ.get("DB_PORT")), 71 | } 72 | } 73 | PASSWORD_VALIDATOR = 'django.contrib.auth.password_validation.' 74 | AUTH_PASSWORD_VALIDATORS = [ 75 | { 76 | 'NAME': f'{PASSWORD_VALIDATOR}UserAttributeSimilarityValidator', 77 | }, 78 | { 79 | 'NAME': f'{PASSWORD_VALIDATOR}MinimumLengthValidator', 80 | }, 81 | { 82 | 'NAME': f'{PASSWORD_VALIDATOR}CommonPasswordValidator', 83 | }, 84 | { 85 | 'NAME': f'{PASSWORD_VALIDATOR}NumericPasswordValidator', 86 | }, 87 | ] 88 | 89 | LANGUAGE_CODE = 'en-us' 90 | 91 | TIME_ZONE = 'America/New_York' 92 | 93 | USE_I18N = True 94 | 95 | USE_L10N = True 96 | # disabled to solve bugs with statistic visit object creation and complicities 97 | # with different timezones 98 | USE_TZ = False 99 | 100 | # STATIC_URL = '/static/' 101 | # MEDIA_URL = '/media/' 102 | # MEDIA_ROOT = os.path.join(BASE_DIR, 'media/') 103 | # STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles') 104 | # STATICFILES_DIRS = ( 105 | # os.path.join(BASE_DIR, 'static'), 106 | # ) 107 | 108 | REST_FRAMEWORK = { 109 | 'TEST_REQUEST_DEFAULT_FORMAT': 'json', 110 | 'DEFAULT_RENDERER_CLASSES': [ 111 | 'rest_framework.renderers.JSONRenderer', 112 | ], 113 | 'DEFAULT_PARSER_CLASSES': [ 114 | 'rest_framework.parsers.JSONParser', 115 | ], 116 | 'DEFAULT_PERMISSION_CLASSES': [ 117 | 'rest_framework.permissions.IsAdminUser', 118 | ], 119 | 'DEFAULT_AUTHENTICATION_CLASSES': [ 120 | 'rest_framework_simplejwt.authentication.JWTAuthentication', 121 | ], 122 | } 123 | # simplejwt configs 124 | SIMPLE_JWT = { 125 | 'ACCESS_TOKEN_LIFETIME': timedelta(days=1), 126 | 'REFRESH_TOKEN_LIFETIME': timedelta(days=3), 127 | 'ROTATE_REFRESH_TOKENS': True, 128 | 'BLACKLIST_AFTER_ROTATION': True, 129 | } 130 | 131 | # swagger configs 132 | SWAGGER_SETTINGS = { 133 | 'USE_SESSION_AUTH': False, 134 | 'SECURITY_DEFINITIONS': { 135 | 'Bearer': { 136 | 'type': 'apiKey', 137 | 'name': 'Authorization', 138 | 'in': 'header' 139 | } 140 | } 141 | } 142 | 143 | # ipstack api access key 144 | IPSTACK_ACCESS_KEY = os.environ.get("IPSTACK_ACCESS_KEY") 145 | # email configs 146 | EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend' 147 | EMAIL_HOST = os.environ.get("CONFIG_EMAIL_HOST") 148 | EMAIL_HOST_USER = os.environ.get("CONFIG_EMAIL_HOST_USER") 149 | EMAIL_HOST_PASSWORD = os.environ.get("CONFIG_EMAIL_HOST_PASSWORD") 150 | EMAIL_USE_TLS = True 151 | EMAIL_PORT = 587 152 | 153 | CORS_ALLOW_ALL_ORIGINS = True 154 | if not DEBUG: 155 | SESSION_COOKIE_SECURE = True 156 | SECURE_HSTS_SECONDS = 259200 157 | # redirect HTTP request to HTTPS 158 | SECURE_SSL_REDIRECT = bool( 159 | int(os.environ.get("CONFIG_SECURE_SSL_REDIRECT", 1))) 160 | 161 | SECURE_PROXY_SSL_HEADER = tuple( 162 | os.environ.get("CONFIG_SECURE_PROXY_SSL_HEADER").split(", ") 163 | ) 164 | -------------------------------------------------------------------------------- /api/views.py: -------------------------------------------------------------------------------- 1 | from rest_framework.views import APIView 2 | from rest_framework import permissions, status, generics 3 | from rest_framework.response import Response 4 | 5 | from django.core.exceptions import ValidationError 6 | from django.contrib.auth.password_validation import validate_password 7 | from django.core.validators import validate_email 8 | from django.shortcuts import get_object_or_404 9 | from django.contrib.auth.models import User 10 | 11 | from .models import Quote, Show, Role 12 | from .serializers import ( 13 | QuoteSerializer, AdminQuoteSerializer, 14 | AdminAddUserSerializer, ShowSerializer, RoleSerializer) 15 | from statistic.utils import get_client_ip, add_or_create_visit 16 | 17 | 18 | class MainPage(APIView): 19 | """Show developers info instead of 404 at the main page""" 20 | permission_classes = (permissions.AllowAny, ) 21 | 22 | def get(self, request, format=None): 23 | all_shows = list(Show.objects.all().values_list('slug', flat=True)) 24 | data = { 25 | "developer": "Faran Taghavi", 26 | "email": "farantgh@gmail.com", 27 | "website": request.get_host(), 28 | "github": "https://github.com/F4R4N", 29 | "showSlugs": all_shows, 30 | "paths": [ 31 | "v1/quote/", 32 | "v1/shows/", 33 | "v1/shows/", 34 | "v1/quote/?censored", 35 | ] 36 | } 37 | return Response(status=status.HTTP_200_OK, data=data) 38 | 39 | 40 | class UserQuoteView(APIView): 41 | """Show a random quote to the user""" 42 | permission_classes = (permissions.AllowAny, ) 43 | 44 | def get(self, request, format=None): 45 | ip = get_client_ip(request) 46 | add_or_create_visit(ip) 47 | if "censored" in request.query_params: 48 | 49 | all_quotes_random = Quote.objects.filter( 50 | contain_adult_lang=False).order_by("?") 51 | else: 52 | all_quotes_random = Quote.objects.all().order_by("?") 53 | 54 | if all_quotes_random.count() == 0: 55 | return Response( 56 | status=status.HTTP_200_OK, 57 | data={ 58 | "detail": "No quote available please try again later.", 59 | "status": "no_quote" 60 | } 61 | ) 62 | serializer = QuoteSerializer(instance=all_quotes_random.first()) 63 | return Response(status=status.HTTP_200_OK, data=serializer.data) 64 | 65 | 66 | class SpecificShowQuotes(APIView): 67 | """Show a random quote from the given slug show (shows slug are listed in 68 | the mainpage)""" 69 | permission_classes = (permissions.AllowAny, ) 70 | 71 | def get(self, request, slug, format=None): 72 | ip = get_client_ip(request) 73 | add_or_create_visit(ip) 74 | requested_show = get_object_or_404(Show, slug=slug) 75 | if not requested_show.show.all().exists(): 76 | return Response( 77 | status=status.HTTP_204_NO_CONTENT, 78 | data={ 79 | "detail": "no quote for this show yet.", 80 | "status": "no_quote_for_show" 81 | } 82 | ) 83 | 84 | quote = requested_show.show.all().order_by("?").first() 85 | 86 | serializer = QuoteSerializer(instance=quote) 87 | return Response(status=status.HTTP_200_OK, data=serializer.data) 88 | 89 | 90 | class AdminQuoteView(generics.ListCreateAPIView): 91 | """GET show all quotes at once (admin only) 92 | POST add new quote (included quote, show, role) (admins only), 93 | show and role should send as string (not object) which is the name of them, 94 | object will create on the server side""" 95 | 96 | queryset = Quote.objects.all() 97 | permission_classes = (permissions.IsAdminUser, ) 98 | serializer_class = AdminQuoteSerializer 99 | 100 | 101 | class AdminEditAndDeleteQuoteView(APIView): 102 | """edit quotes get field 'quote', 'role', 'show' 103 | should include quote key in the url. 104 | only can change show and role to an existed show and role object.""" 105 | 106 | permission_classes = (permissions.IsAdminUser, ) 107 | 108 | def put(self, request, key, format=None): 109 | if "quote" not in request.data and "show" not in request.data and "role" not\ 110 | in request.data and "contain_adult_lang" not in request.data: 111 | return Response( 112 | status=status.HTTP_400_BAD_REQUEST, 113 | data={"detail": "no new data provided"} 114 | ) 115 | 116 | quote = get_object_or_404(Quote, key=key) 117 | if "show" in request.data: 118 | show = get_object_or_404(Show, name=request.data["show"].title()) 119 | quote.show = show 120 | if "role" in request.data: 121 | role = get_object_or_404(Role, name=request.data["role"].title()) 122 | quote.role = role 123 | if "quote" in request.data: 124 | quote.quote = request.data["quote"] 125 | if "contain_adult_lang" in request.data: 126 | quote.contain_adult_lang = request.data["contain_adult_lang"] 127 | quote.save() 128 | return Response(status=status.HTTP_200_OK, data={"detail": "updated"}) 129 | 130 | def delete(self, request, key, format=None): 131 | quote = get_object_or_404(Quote, key=key) 132 | quote.delete() 133 | return Response(status=status.HTTP_200_OK, data={"detail": "deleted"}) 134 | 135 | 136 | class AdminEditShowView(APIView): 137 | """Edit show get field 'name' should include show slug in url""" 138 | permission_classes = (permissions.IsAdminUser, ) 139 | 140 | def put(self, request, slug, format=None): 141 | if "name" not in request.data: 142 | return Response( 143 | status=status.HTTP_400_BAD_REQUEST, 144 | data={ 145 | "detail": "no new data provided.", 146 | "name": "this field is required." 147 | } 148 | ) 149 | 150 | show = get_object_or_404(Show, slug=slug) 151 | show.name = request.data["name"] 152 | show.save() 153 | return Response(status=status.HTTP_200_OK, data={"detail": "show updated"}) 154 | 155 | 156 | class AllShowsView(generics.ListAPIView): 157 | """List all shows""" 158 | permission_classes = (permissions.AllowAny, ) 159 | serializer_class = ShowSerializer 160 | queryset = Show.objects.all() 161 | 162 | 163 | class AdminEditRoleView(APIView): 164 | """Edit role get field 'name' should include role slug in url.""" 165 | permission_classes = (permissions.IsAdminUser, ) 166 | 167 | def put(self, request, slug, format=None): 168 | if "name" not in request.data: 169 | return Response( 170 | status=status.HTTP_400_BAD_REQUEST, 171 | data={ 172 | "detail": "no new data provided.", 173 | "name": "this field is required." 174 | } 175 | ) 176 | 177 | role = get_object_or_404(Role, slug=slug) 178 | role.name = request.data["name"] 179 | role.save() 180 | return Response(status=status.HTTP_200_OK, data={"detail": "role updated."}) 181 | 182 | 183 | class AdminAllRolesView(generics.ListAPIView): 184 | """Show all roles to admin user.""" 185 | permission_classes = (permissions.IsAdminUser, ) 186 | serializer_class = RoleSerializer 187 | queryset = Role.objects.all() 188 | 189 | 190 | class AdminUserView(generics.ListCreateAPIView): 191 | """GET return all users (admin only). 192 | POST add new user (admin only) [username, first_name, last_name, email, 193 | password1, password2](only main superuser can make user). 194 | """ 195 | 196 | queryset = User.objects.all() 197 | permission_classes = (permissions.IsAdminUser, ) 198 | serializer_class = AdminAddUserSerializer 199 | 200 | 201 | class AdminEditUserView(APIView): 202 | """Edit user credentials (every user can edit it selves profile. 203 | also main superuser can edit every users profile.). 204 | it should include at least one of : [first_name, last_name, username, email, 205 | (together [password1,password2]), (only main superuser can modify this 206 | [is_superuser, is_active, is_staff]) ]. 207 | """ 208 | 209 | permission_classes = (permissions.IsAuthenticated, ) 210 | 211 | def put(self, request, pk, format=None): 212 | user = request.user 213 | main_superuser_username = User.objects.filter( 214 | is_superuser=True, 215 | is_staff=True, 216 | is_active=True 217 | ).first().username 218 | if user != User.objects.get(pk=pk) and not user.is_superuser\ 219 | and user.username != main_superuser_username: 220 | return Response( 221 | status=status.HTTP_401_UNAUTHORIZED, 222 | data={"detail": "you don't have permission for this user"}) 223 | 224 | instance = get_object_or_404(User, pk=pk) 225 | 226 | if "first_name" in request.data: 227 | instance.first_name = request.data['first_name'] 228 | if "last_name" in request.data: 229 | instance.last_name = request.data['last_name'] 230 | if "username" in request.data: 231 | if User.objects.filter(username=request.data['username']).exists(): 232 | return Response( 233 | status=status.HTTP_400_BAD_REQUEST, 234 | data={"detail": "username already exist"}) 235 | 236 | instance.username = request.data['username'] 237 | if "email" in request.data: 238 | try: 239 | validate_email(request.data["email"]) 240 | except ValidationError as eex: 241 | return Response( 242 | status=status.HTTP_400_BAD_REQUEST, data={"detail": {"email": eex}}) 243 | 244 | instance.email = request.data['email'] 245 | 246 | if "password1" in request.data: 247 | if "password2" not in request.data: 248 | return Response( 249 | status=status.HTTP_400_BAD_REQUEST, 250 | data={"detail": "password2 field not provided"}) 251 | 252 | if request.data['password1'] != request.data["password2"]: 253 | return Response( 254 | status=status.HTTP_400_BAD_REQUEST, 255 | data={"detail": "password fields don't match"}) 256 | 257 | try: 258 | validate_password(request.data['password1'], user) 259 | instance.set_password(request.data['password1']) 260 | except ValidationError as ex: 261 | return Response( 262 | status=status.HTTP_400_BAD_REQUEST, data={"detail": {"password": ex}}) 263 | 264 | if "is_superuser" in request.data or "is_active" in request.data\ 265 | or "is_staff" in request.data: 266 | if user.username != main_superuser_username: 267 | return Response( 268 | status=status.HTTP_401_UNAUTHORIZED, 269 | data={ 270 | "detail": "you don't have permission to perform \ 271 | this action, contact the admin user" 272 | } 273 | ) 274 | 275 | if "is_superuser" in request.data: 276 | instance.is_superuser = request.data["is_superuser"] 277 | if "is_active" in request.data: 278 | instance.is_active = request.data['is_active'] 279 | if "is_staff" in request.data: 280 | instance.is_staff = request.data['is_staff'] 281 | instance.save() 282 | return Response(status=status.HTTP_200_OK, data={"detail": "user updated"}) 283 | 284 | 285 | class AdminDeleteUserView(APIView): 286 | """Main super user can delete anyone and anyone can delete itself, 287 | put pk in url. 288 | """ 289 | 290 | permission_classes = (permissions.IsAdminUser, ) 291 | 292 | def delete(self, request, pk, format=None): 293 | user = request.user 294 | deletable_user = get_object_or_404(User, pk=pk) 295 | if user.username != User.objects.filter( 296 | is_superuser=True, 297 | is_staff=True, 298 | is_active=True 299 | ).first().username: 300 | if user != deletable_user: 301 | return Response( 302 | status=status.HTTP_400_BAD_REQUEST, 303 | data={"detail": "you don't have permission for this user."}) 304 | 305 | deletable_user.is_active = False 306 | deletable_user.save() 307 | return Response( 308 | status=status.HTTP_200_OK, 309 | data={"detail": "user '{0}' deleted".format(deletable_user.username)}) 310 | 311 | # class SuggestionTicketView() 312 | -------------------------------------------------------------------------------- /api/tests.py: -------------------------------------------------------------------------------- 1 | from rest_framework.test import APITestCase 2 | from django.shortcuts import reverse 3 | from .models import Show, Role, Quote 4 | from django.contrib.auth.models import User 5 | import json 6 | from rest_framework_simplejwt.tokens import RefreshToken 7 | from django.utils.text import slugify 8 | 9 | random_quote = "api:random_quote" 10 | test_quote_text = "test quote" 11 | AUTH_TOKEN_PREFIX = "Bearer " 12 | EMAIL = "test@test.com" 13 | 14 | 15 | class MainPageTestCase(APITestCase): 16 | url = reverse("api:main_page") 17 | 18 | def setUp(self): 19 | self.show_name1 = "test_show1" 20 | self.show_name2 = "test_show2" 21 | 22 | self.create_show() 23 | 24 | def create_show(self): 25 | Show.objects.create(name=self.show_name1) 26 | Show.objects.create(name=self.show_name2) 27 | 28 | def test_path_accessibility(self): 29 | response = self.client.get(self.url) 30 | self.assertEqual( 31 | response.status_code, 32 | 200, 33 | f"expected status code 200, got {response.status_code}") 34 | 35 | def test_shows_list(self): 36 | response = self.client.get(self.url) 37 | self.assertEqual( 38 | response.json()["showSlugs"], [self.show_name1, self.show_name2]) 39 | 40 | 41 | class RandomQuoteTestCase(APITestCase): 42 | url = reverse(random_quote) 43 | url_censored = "%s?censored" % reverse(random_quote) 44 | 45 | def setUp(self): 46 | self.show_name = "test_show" 47 | self.role_name = "test_role" 48 | self.quote = test_quote_text 49 | self.contain_adult_lang = True 50 | 51 | self.create_quote() 52 | 53 | def create_quote(self): 54 | show = Show.objects.create(name=self.show_name) 55 | role = Role.objects.create(name=self.role_name) 56 | Quote.objects.create( 57 | quote=self.quote, 58 | show=show, 59 | role=role, 60 | contain_adult_lang=self.contain_adult_lang 61 | ) 62 | 63 | def test_quote(self): 64 | response = self.client.get(self.url) 65 | self.assertEqual( 66 | response.status_code, 200, 67 | f"expected status code 200, got {response.status_code}") 68 | 69 | self.assertEqual( 70 | response.json()["quote"], self.quote, "quote don't match") 71 | 72 | self.assertEqual( 73 | response.json()["show"], self.show_name, "show name don't match") 74 | 75 | self.assertEqual( 76 | response.json()["role"], self.role_name, "role name don't match") 77 | 78 | self.assertTrue(response.json()["contain_adult_lang"]) 79 | 80 | def test_censored_quote_not_accessible(self): 81 | response = self.client.get(self.url_censored) 82 | self.assertEqual( 83 | response.status_code, 200, 84 | f"expected status code 200, got {response.status_code}") 85 | 86 | self.assertEqual(response.json()["status"], "no_quote") 87 | 88 | 89 | class CensoredQuoteTestCase(APITestCase): 90 | url = "%s?censored" % reverse(random_quote) 91 | 92 | def setUp(self): 93 | self.show_name = "test_show" 94 | self.role_name = "test_role" 95 | self.quote = test_quote_text 96 | self.contain_adult_lang = False 97 | 98 | self.create_quote() 99 | 100 | def create_quote(self): 101 | show = Show.objects.create(name=self.show_name) 102 | role = Role.objects.create(name=self.role_name) 103 | Quote.objects.create( 104 | quote=self.quote, 105 | show=show, 106 | role=role, 107 | contain_adult_lang=self.contain_adult_lang 108 | ) 109 | 110 | def test_censored_quote_accessible(self): 111 | response = self.client.get(self.url) 112 | 113 | self.assertEqual( 114 | response.status_code, 200, 115 | f"expected status code 200, got {response.status_code}") 116 | 117 | self.assertEqual(response.json()["quote"], self.quote) 118 | 119 | 120 | class SpecificShowQuotesTestCase(APITestCase): 121 | url_path = "api:show_quote" 122 | 123 | def setUp(self): 124 | self.show_name = "test_show" 125 | self.role_name = "test_role" 126 | self.quote = test_quote_text 127 | self.contain_adult_lang = False 128 | self.alter_show_name = "alter_test_show_name" 129 | self.create_objects() 130 | 131 | def create_objects(self): 132 | show = Show.objects.create(name=self.show_name) 133 | role = Role.objects.create(name=self.role_name) 134 | Quote.objects.create( 135 | quote=self.quote, 136 | show=show, 137 | role=role, 138 | contain_adult_lang=self.contain_adult_lang 139 | ) 140 | Show.objects.create(name=self.alter_show_name) 141 | 142 | def test_quote_valid(self): 143 | url = reverse(self.url_path, kwargs={"slug": self.show_name}) 144 | response = self.client.get(url) 145 | 146 | self.assertEqual( 147 | response.status_code, 200, 148 | f"expected status code 200, got {response.status_code}") 149 | 150 | self.assertEqual( 151 | response.json()["quote"], 152 | self.quote 153 | ) 154 | 155 | self.assertEqual( 156 | response.json()["show"], 157 | self.show_name 158 | ) 159 | 160 | def test_quote_invalid(self): 161 | url = reverse(self.url_path, kwargs={"slug": "invalid_show_slug"}) 162 | response = self.client.get(url) 163 | 164 | self.assertEqual( 165 | response.status_code, 404, 166 | f"expected status code 404, got {response.status_code}") 167 | 168 | self.assertEqual( 169 | response.json()["detail"], 170 | "Not found." 171 | ) 172 | 173 | def test_no_quote_associate_with_show(self): 174 | url = reverse(self.url_path, kwargs={"slug": self.alter_show_name}) 175 | response = self.client.get(url) 176 | 177 | self.assertEqual( 178 | response.status_code, 204, 179 | f"expected status code 204, got {response.status_code}") 180 | 181 | 182 | class AdminCreateListQuoteTestCase(APITestCase): 183 | url = reverse("api:admin_create_list_quote") 184 | 185 | def setUp(self): 186 | self.show_name = "test show creation" 187 | self.role_name = "test role creation" 188 | self.data = json.dumps( 189 | { 190 | "show": self.show_name, 191 | "role": self.role_name, 192 | "quote": "some quote", 193 | "contain_adult_lang": True 194 | } 195 | ) 196 | self.invalid_data = json.dumps( 197 | { 198 | "show": self.show_name, 199 | "role": self.role_name, 200 | } 201 | ) 202 | self.username = "test" 203 | self.password = "sometestpassword" 204 | self.create() 205 | self.header = { 206 | "HTTP_AUTHORIZATION": 207 | AUTH_TOKEN_PREFIX + str( 208 | RefreshToken.for_user(self.user).access_token) 209 | } 210 | 211 | def create(self): 212 | show = Show.objects.create(name=self.show_name) 213 | role = Role.objects.create(name=self.role_name) 214 | Quote.objects.create( 215 | show=show, 216 | role=role, 217 | quote=test_quote_text 218 | ) 219 | self.user = User.objects.create( 220 | username=self.username, 221 | is_staff=True, 222 | is_superuser=True, 223 | is_active=True, 224 | email=EMAIL, 225 | password=self.password 226 | ) 227 | 228 | def test_quote_creation_invalid_authentication(self): 229 | response = self.client.post( 230 | self.url, 231 | data=self.data 232 | ) 233 | self.assertEqual( 234 | response.status_code, 401, 235 | f"expected status code 401, got {response.status_code}") 236 | 237 | def test_quote_creation_valid_authentication(self): 238 | response = self.client.post( 239 | self.url, 240 | self.data, content_type="application/json", **self.header 241 | ) 242 | self.assertEqual( 243 | response.status_code, 201, 244 | f"expected status code 201, got {response.status_code}") 245 | 246 | def test_quote_creation_ivalid_data(self): 247 | response = self.client.post( 248 | self.url, data=self.invalid_data, **self.header) 249 | 250 | self.assertEqual( 251 | response.status_code, 400, 252 | f"expected status code 400, got {response.status_code}") 253 | 254 | def test_quote_list(self): 255 | response = self.client.get(self.url, **self.header) 256 | self.assertEqual( 257 | response.status_code, 200, 258 | f"expected status code 200, got {response.status_code}" 259 | ) 260 | self.assertEqual( 261 | len(response.json()), 1, 262 | f"expected 1 object, got {len(response.json())}" 263 | ) 264 | 265 | 266 | class EditAndDeleteQuoteTestCase(APITestCase): 267 | def setUp(self): 268 | self.show_name1 = "test show creation1".title() 269 | self.role_name1 = "test role creation1".title() 270 | self.show_name2 = "test show creation2".title() 271 | self.role_name2 = "test role creation2".title() 272 | self.username = "test" 273 | self.password = "sometestpassword" 274 | self.create() 275 | self.url = reverse( 276 | "api:admin_edit_delete_quote", kwargs={"key": self.quote.key}) 277 | 278 | self.header = { 279 | "HTTP_AUTHORIZATION": 280 | AUTH_TOKEN_PREFIX + str( 281 | RefreshToken.for_user(self.user).access_token) 282 | } 283 | 284 | def create(self): 285 | show1 = Show.objects.create(name=self.show_name1) 286 | role1 = Role.objects.create(name=self.role_name1) 287 | self.show2 = Show.objects.create(name=self.show_name2) 288 | self.role2 = Role.objects.create(name=self.role_name2) 289 | self.quote = Quote.objects.create( 290 | show=show1, 291 | role=role1, 292 | quote=test_quote_text, 293 | contain_adult_lang=True 294 | ) 295 | self.user = User.objects.create( 296 | username=self.username, 297 | is_staff=True, 298 | is_superuser=True, 299 | is_active=True, 300 | email=EMAIL, 301 | password=self.password 302 | ) 303 | 304 | def test_edit_quote_valid(self): 305 | data = { 306 | "show": self.show_name2, 307 | "contain_adult_lang": False 308 | } 309 | response = self.client.put( 310 | self.url, data, **self.header) 311 | self.assertEqual( 312 | response.status_code, 200, 313 | f"expected status code 200, got {response.status_code}") 314 | self.assertEqual(response.json()["detail"], "updated") 315 | 316 | def test_edit_quote_invalid(self): 317 | data = { 318 | "show": "test valid show name", 319 | "role": "test valid role name", 320 | "contain_adult_lang": False 321 | } 322 | response = self.client.put( 323 | self.url, data, **self.header) 324 | self.assertEqual( 325 | response.status_code, 404, 326 | f"expected status code 404, got {response.status_code}") 327 | self.assertEqual(response.json()["detail"], "Not found.") 328 | 329 | def test_delete_quote_valid(self): 330 | response = self.client.delete( 331 | self.url, 332 | **self.header 333 | ) 334 | self.assertEqual( 335 | response.status_code, 200, 336 | f"expected status code 200, got {response.status_code}") 337 | self.assertEqual(response.json()["detail"], "deleted") 338 | 339 | 340 | class EditShowTestCase(APITestCase): 341 | def setUp(self): 342 | self.show_name1 = "test show creation1" 343 | self.show_name2 = "test show creation2".title() 344 | self.username = "test" 345 | self.password = "sometestpassword" 346 | self.create() 347 | self.url = reverse( 348 | "api:admin_edit_show", kwargs={"slug": slugify(self.show_name1)}) 349 | 350 | self.header = { 351 | "HTTP_AUTHORIZATION": 352 | AUTH_TOKEN_PREFIX + str( 353 | RefreshToken.for_user(self.user).access_token) 354 | } 355 | 356 | def create(self): 357 | Show.objects.create(name=self.show_name1) 358 | self.user = User.objects.create( 359 | username=self.username, 360 | is_staff=True, 361 | is_superuser=True, 362 | is_active=True, 363 | email=EMAIL, 364 | password=self.password 365 | ) 366 | 367 | def test_edit_show_valid(self): 368 | response = self.client.put( 369 | self.url, 370 | {"name": self.show_name2}, 371 | **self.header 372 | ) 373 | self.assertEqual( 374 | response.status_code, 200, 375 | f"expected status code 200, got {response.status_code}") 376 | self.assertEqual(response.json()["detail"], "show updated") 377 | all_shows = Show.objects.all() 378 | self.assertEqual(len(all_shows), 1) 379 | self.assertEqual(all_shows[0].name, self.show_name2) 380 | 381 | def test_edit_show_invalid_data(self): 382 | response = self.client.put( 383 | self.url, 384 | {"hello": self.show_name1}, 385 | **self.header 386 | ) 387 | self.assertEqual( 388 | response.status_code, 400, 389 | f"expected status code 400, got {response.status_code}") 390 | self.assertEqual(response.json()["detail"], "no new data provided.") 391 | 392 | def test_edit_show_no_token(self): 393 | response = self.client.put( 394 | self.url, 395 | {"name": self.show_name1} 396 | ) 397 | self.assertEqual( 398 | response.status_code, 401, 399 | f"expected status code 401, got {response.status_code}") 400 | 401 | def test_invalid_http_method(self): 402 | response = self.client.post( 403 | self.url, 404 | {"name": self.show_name1}, 405 | **self.header 406 | ) 407 | self.assertEqual( 408 | response.status_code, 409 | 405, 410 | f"expected status code 405, got {response.status_code}" 411 | ) 412 | 413 | def test_edit_show_not_exist_show(self): 414 | url = reverse( 415 | "api:admin_edit_show", 416 | kwargs={"slug": "its_test"}) 417 | response = self.client.put( 418 | url, 419 | {"name", "its_not_test"}, 420 | **self.header 421 | ) 422 | self.assertEqual( 423 | response.status_code, 404, 424 | f"expected status code 404, got {response.status_code}" 425 | ) 426 | 427 | 428 | class AllShowsTestCase(APITestCase): 429 | def setUp(self): 430 | self.show_name1 = "test show creation1".title() 431 | self.show_name2 = "test show creation2".title() 432 | self.create() 433 | self.url = reverse( 434 | "api:all_shows") 435 | 436 | def create(self): 437 | Show.objects.create(name=self.show_name1) 438 | Show.objects.create(name=self.show_name2) 439 | 440 | def test_show_availability(self): 441 | response = self.client.get(self.url) 442 | self.assertEqual( 443 | response.status_code, 200, 444 | f"expected status code 200, got {response.status_code}") 445 | self.assertEqual(len(response.json()), 2) 446 | self.assertEqual(response.json()[0]["name"], self.show_name1) 447 | 448 | def test_invalid_methods(self): 449 | post = self.client.post(self.url) 450 | put = self.client.put(self.url) 451 | delete = self.client.delete(self.url) 452 | self.assertEqual(post.status_code, 405) 453 | self.assertEqual(put.status_code, 405) 454 | self.assertEqual(delete.status_code, 405) 455 | 456 | 457 | class EditRoleTestCase(APITestCase): 458 | def setUp(self): 459 | self.role_name1 = "test role creation1" 460 | self.role_name2 = "test role creation2".title() 461 | self.username = "test" 462 | self.password = "sometestpassword" 463 | self.create() 464 | self.url = reverse( 465 | "api:admin_edit_role", kwargs={"slug": slugify(self.role_name1)}) 466 | 467 | self.header = { 468 | "HTTP_AUTHORIZATION": 469 | AUTH_TOKEN_PREFIX + str( 470 | RefreshToken.for_user(self.user).access_token) 471 | } 472 | 473 | def create(self): 474 | Role.objects.create(name=self.role_name1) 475 | self.user = User.objects.create( 476 | username=self.username, 477 | is_staff=True, 478 | is_superuser=True, 479 | is_active=True, 480 | email=EMAIL, 481 | password=self.password 482 | ) 483 | 484 | def test_edit_role_valid(self): 485 | response = self.client.put( 486 | self.url, 487 | {"name": self.role_name2}, 488 | **self.header, 489 | ) 490 | self.assertEqual( 491 | response.status_code, 200, 492 | f"expected status code 200, got {response.status_code}" 493 | ) 494 | self.assertEqual( 495 | response.json()["detail"], 496 | "role updated." 497 | ) 498 | 499 | def test_edit_role_invalid_data(self): 500 | response = self.client.put( 501 | self.url, 502 | {"hello": self.role_name2}, 503 | **self.header 504 | ) 505 | self.assertEqual( 506 | response.status_code, 400 507 | ) 508 | self.assertEqual( 509 | response.json()["detail"], 510 | "no new data provided.", 511 | ) 512 | 513 | def test_not_exist_role(self): 514 | url = reverse( 515 | "api:admin_edit_role", kwargs={"slug": "not_exists_test_role"}) 516 | response = self.client.put( 517 | url, {"name": "test role name"}, 518 | **self.header 519 | ) 520 | self.assertEqual( 521 | response.status_code, 404, 522 | f"expected status code 404, got {response.status_code}" 523 | ) 524 | 525 | def test_invalid_methods(self): 526 | post = self.client.post(self.url, {"name": "test"}, **self.header) 527 | get = self.client.get(self.url, **self.header) 528 | delete = self.client.delete(self.url, **self.header) 529 | self.assertEqual(post.status_code, 405, post.content) 530 | self.assertEqual(get.status_code, 405, get.content) 531 | self.assertEqual(delete.status_code, 405, delete.content) 532 | 533 | 534 | class AdminListAllRolesTestCase(APITestCase): 535 | def setUp(self): 536 | self.role_name1 = "test role creation1".title() 537 | self.role_name2 = "test role creation2".title() 538 | self.role_name3 = "test role creation3".title() 539 | self.username = "test" 540 | self.password = "sometestpassword" 541 | self.create() 542 | self.url = reverse( 543 | "api:admin_all_roles") 544 | self.header = { 545 | "HTTP_AUTHORIZATION": 546 | AUTH_TOKEN_PREFIX + str( 547 | RefreshToken.for_user(self.user).access_token) 548 | } 549 | 550 | def create(self): 551 | Role.objects.create(name=self.role_name1) 552 | Role.objects.create(name=self.role_name2) 553 | Role.objects.create(name=self.role_name3) 554 | self.user = User.objects.create( 555 | username=self.username, 556 | is_staff=True, 557 | is_superuser=True, 558 | is_active=True, 559 | email=EMAIL, 560 | password=self.password 561 | ) 562 | 563 | def test_role_availability(self): 564 | response = self.client.get( 565 | self.url, 566 | **self.header 567 | ) 568 | self.assertEqual( 569 | response.status_code, 200, 570 | f"expected status code 200, got {response.status_code}" 571 | ) 572 | self.assertEqual( 573 | len(response.json()), 3, 574 | f"expected 3 object, got {len(response.json())}" 575 | ) 576 | 577 | def test_invalid_methods(self): 578 | post = self.client.post(self.url, {"name": "test"}, **self.header) 579 | put = self.client.put(self.url, **self.header) 580 | delete = self.client.delete(self.url, **self.header) 581 | self.assertEqual(post.status_code, 405, post.content) 582 | self.assertEqual(put.status_code, 405, put.content) 583 | self.assertEqual(delete.status_code, 405, delete.content) 584 | 585 | 586 | class AdminAddListUserTestCase(APITestCase): 587 | def setUp(self): 588 | self.admin_username = "admin" 589 | self.admin_password = "password" 590 | self.username1 = "test1" 591 | self.password1 = "sometestpassword" 592 | self.username2 = "test2" 593 | self.password2 = "sometestpassword" 594 | self.data = { 595 | "username": "test", 596 | "email": "test1@test.com", 597 | "first_name": "test", 598 | "last_name": "test", 599 | "is_active": True, 600 | "is_superuser": True, 601 | "password1": "this is a password", 602 | "password2": "this is a password" 603 | } 604 | self.create() 605 | self.url = reverse( 606 | "api:admin_create_list_user") 607 | self.header = { 608 | "HTTP_AUTHORIZATION": 609 | AUTH_TOKEN_PREFIX + str( 610 | RefreshToken.for_user(self.user).access_token) 611 | } 612 | 613 | def create(self): 614 | self.user = User.objects.create( 615 | username=self.admin_username, 616 | is_staff=True, 617 | is_superuser=True, 618 | is_active=True, 619 | email=EMAIL, 620 | password=self.admin_password 621 | ) 622 | User.objects.create( 623 | username=self.username1, 624 | password=self.password1, 625 | email="1" + EMAIL 626 | ) 627 | User.objects.create( 628 | username=self.username2, 629 | password=self.password2, 630 | email="2" + EMAIL 631 | ) 632 | 633 | def test_list_all_users(self): 634 | response = self.client.get( 635 | self.url, 636 | **self.header 637 | ) 638 | self.assertEqual( 639 | response.status_code, 200, 640 | f"expected status code 200, got {response.status_code}" 641 | ) 642 | self.assertEqual( 643 | len(response.json()), 3, 644 | f"expected 3 object, got {len(response.json())}" 645 | ) 646 | 647 | def test_create_user_valid(self): 648 | response = self.client.post( 649 | self.url, 650 | self.data, 651 | **self.header 652 | ) 653 | self.assertEqual( 654 | response.status_code, 201, 655 | f"expected status code 201, got {response.status_code}" 656 | ) 657 | -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | --------------------------------------------------------------------------------