tildetown
/
tildetown-admin
1
0
Fork 0
Code Issues 9 Pull Requests Releases Wiki Activity

Compare commits

base: tildetown:master
Branches Tags
tildetown:master
tildetown:helpdesk-email
tildetown:admin-improvements
tildetown:zoho
tildetown:pause-signups
tildetown:new-signup-questions
tildetown:feature/enhanced-ticket-view
tildetown:add-key-for-user
..
compare: tildetown:zoho
Branches Tags
tildetown:master
tildetown:helpdesk-email
tildetown:admin-improvements
tildetown:zoho
tildetown:pause-signups
tildetown:new-signup-questions
tildetown:feature/enhanced-ticket-view
tildetown:add-key-for-user

No commits in common. "master" and "zoho" have entirely different histories.
master ... zoho

21 changed files with 50 additions and 334 deletions
Show Stats Expand all files Collapse all files

2
README.md
View File

@ -10,7 +10,7 @@ _Being an adminstrative tool written in Django for <https://tilde.town>_.
* [x] Helpdesk * [x] Helpdesk
* [x] User account management * [x] User account management
* [ ] Start/stop services * [ ] Start/stop services
* [ ] Cost reporting from DO * [ ] Cost reporting from AWS
* [ ] Status monitoring * [ ] Status monitoring
## Requirements ## Requirements

2
scripts/start.sh
View File

@ -9,4 +9,4 @@ VENV=/town/venvs/ttadmin
source $VENV/bin/activate source $VENV/bin/activate
export DJANGO_SETTINGS_MODULE=settings_live export DJANGO_SETTINGS_MODULE=settings_live
cd $APP_ROOT cd $APP_ROOT
gunicorn -t120 -b0.0.0.0:$PORT ttadmin.wsgi gunicorn -b0.0.0.0:$PORT ttadmin.wsgi

8
setup.py
View File

@ -15,11 +15,11 @@ setup(
'License :: OSI Approved :: Affero GNU General Public License v3 (AGPLv3)', 'License :: OSI Approved :: Affero GNU General Public License v3 (AGPLv3)',
], ],
packages=['ttadmin'], packages=['ttadmin'],
install_requires = ['Django==1.11.29', install_requires = ['Django==1.10.2',
'sshpubkeys==2.2.0', 'sshpubkeys==2.2.0',
'psycopg2-binary==2.8.5', 'psycopg2==2.7.6.1',
'gunicorn==19.6.0', 'gunicorn==19.6.0',
'Mastodon.py==1.4.5', 'Mastodon.py==1.1.1',
'tweepy==3.7.0'], 'tweepy==3.5.0'],
include_package_data = True, include_package_data = True,
) )

4
ttadmin/guestbook/templates/guestbook/guestbook.html
View File

@ -20,15 +20,15 @@
</head> </head>
<body> <body>
<h1>tilde.town guestbook</h1> <h1>tilde.town guestbook</h1>
<p><em>don't try to post urls. it won't work.</em></p>
<marquee>~*~*~*~*say hello*~*~*~*~</marquee> <marquee>~*~*~*~*say hello*~*~*~*~</marquee>
<form class="tilde" action="{% url 'guestbook:guestbook' %}" method="post"> <!-- <form class="tilde" action="{% url 'guestbook:guestbook' %}" method="post">
{% csrf_token %} {% csrf_token %}
<table> <table>
{{form.as_table}} {{form.as_table}}
</table> </table>
<input type="submit" value="sign" > <input type="submit" value="sign" >
</form> </form>
-->
{% for m in messages %} {% for m in messages %}
<p> <p>

6
ttadmin/guestbook/views.py
View File

@ -1,5 +1,3 @@
import re
from django.shortcuts import redirect from django.shortcuts import redirect
from django.views.generic import TemplateView from django.views.generic import TemplateView
from django.views.generic.edit import FormView from django.views.generic.edit import FormView
@ -7,8 +5,6 @@ from django.views.generic.edit import FormView
from .forms import GuestbookForm from .forms import GuestbookForm
from .models import GuestbookMessage from .models import GuestbookMessage
SUSPICIOUS_RE = re.compile(r'https?://')
class GuestbookView(FormView): class GuestbookView(FormView):
form_class = GuestbookForm form_class = GuestbookForm
@ -21,7 +17,5 @@ class GuestbookView(FormView):
def form_valid(self, form): def form_valid(self, form):
del form.cleaned_data['captcha'] del form.cleaned_data['captcha']
if SUSPICIOUS_RE.search(form.cleaned_data['msg']) != None:
return redirect('guestbook:guestbook')
t = GuestbookMessage.objects.create(**form.cleaned_data) t = GuestbookMessage.objects.create(**form.cleaned_data)
return redirect('guestbook:guestbook') return redirect('guestbook:guestbook')

45
ttadmin/help/admin.py
View File

@ -1,44 +1,9 @@
from django.contrib import admin from django.contrib import admin
from django.forms import ModelForm from .models import Ticket
from .models import Ticket, Note
class ImmutableNoteInline(admin.TabularInline):
model = Note
extra = 1
max_num = 0
fields = ('author', 'created', 'body')
readonly_fields = ('author', 'created', 'body')
can_delete = False
ordering = ('created',)
class NewNoteInline(admin.StackedInline):
model = Note
extra = 0
fields = ('body',)
def get_queryset(self, request):
queryset = super().get_queryset(request)
return queryset.none()
@admin.register(Ticket) @admin.register(Ticket)
class TicketAdmin(admin.ModelAdmin): class TicketAdmin(admin.ModelAdmin):
inlines = [ImmutableNoteInline, NewNoteInline] readonly_fields = ('submitted',)
readonly_fields = ('submitted', 'issue_type') list_display = ('submitted', 'issue_status', 'issue_type', 'name', 'email')
list_display = ('submitted', 'issue_status', 'assigned', 'issue_type', 'name', 'email',) list_filter = ('issue_status', 'issue_type')
list_filter = ('issue_status', 'issue_type', 'assigned') fields = ('submitted', 'name', 'email', 'issue_status', 'issue_type', 'issue_text')
fields = ('submitted', 'name', 'email', 'assigned', 'issue_status', 'issue_type', 'issue_text')
def save_related(self, request, form, formsets, change):
# THIS IS EXTREMELY BOOTLEG AND MAY BREAK IF MORE INLINES ARE ADDED TO THIS ADMIN.
for formset in formsets:
if len(formset.forms) == 1:
# It's probably the add new note form (i hope).
note_form = formset.forms[0]
note_form.instance.author = request.user
note_form.instance.save()
note_form.save(commit=False)
note_form.save_m2m()
return super().save_related(request, form, formsets, change)

27
ttadmin/help/migrations/0005_note.py
View File

@ -1,27 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-16 02:43
from __future__ import unicode_literals
from django.db import migrations, models
import django.db.models.deletion
class Migration(migrations.Migration):
dependencies = [
('users', '0015_remove_townie_reviewed'),
('help', '0004_ticket_submitted'),
]
operations = [
migrations.CreateModel(
name='Note',
fields=[
('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('created', models.DateTimeField(auto_now_add=True)),
('body', models.TextField()),
('author', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='users.Townie')),
('ticket', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='help.Ticket')),
],
),
]

22
ttadmin/help/migrations/0006_auto_20190716_0258.py
View File

@ -1,22 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-16 02:58
from __future__ import unicode_literals
from django.conf import settings
from django.db import migrations, models
import django.db.models.deletion
class Migration(migrations.Migration):
dependencies = [
('help', '0005_note'),
]
operations = [
migrations.AlterField(
model_name='note',
name='author',
field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
),
]

23
ttadmin/help/migrations/0007_ticket_assigned.py
View File

@ -1,23 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-18 22:21
from __future__ import unicode_literals
from django.conf import settings
from django.db import migrations, models
import django.db.models.deletion
class Migration(migrations.Migration):
dependencies = [
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
('help', '0006_auto_20190716_0258'),
]
operations = [
migrations.AddField(
model_name='ticket',
name='assigned',
field=models.ForeignKey(help_text='Assign this ticket to an admin or unassign it.', null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
),
]

22
ttadmin/help/migrations/0008_auto_20190718_2223.py
View File

@ -1,22 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-18 22:23
from __future__ import unicode_literals
from django.conf import settings
from django.db import migrations, models
import django.db.models.deletion
class Migration(migrations.Migration):
dependencies = [
('help', '0007_ticket_assigned'),
]
operations = [
migrations.AlterField(
model_name='ticket',
name='assigned',
field=models.ForeignKey(blank=True, help_text='Assign this ticket to an admin or unassign it.', null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
),
]

14
ttadmin/help/models.py
View File

@ -1,5 +1,4 @@
from django.contrib.auth.models import User from django.db.models import Model, TextField, EmailField, CharField, DateTimeField
from django.db.models import Model, TextField, EmailField, CharField, DateTimeField, ForeignKey
ISSUE_TYPE_CHOICES = ( ISSUE_TYPE_CHOICES = (
('logging_in', 'help logging in'), ('logging_in', 'help logging in'),
@ -32,17 +31,6 @@ class Ticket(Model):
null=False, null=False,
max_length=50, max_length=50,
default=ISSUE_STATUS_CHOICES[0][0]) default=ISSUE_STATUS_CHOICES[0][0])
assigned = ForeignKey(User, blank=True, null=True, help_text="Assign this ticket to an admin or unassign it.")
def __str__(self): def __str__(self):
return '{} from {}'.format(self.issue_type, self.name) return '{} from {}'.format(self.issue_type, self.name)
class Note(Model):
created = DateTimeField(auto_now_add=True)
body = TextField(blank=False, null=False)
author = ForeignKey(User)
ticket = ForeignKey(Ticket)
def __str__(self):
return "admin note"

4
ttadmin/urls.py
View File

@ -2,8 +2,8 @@ from django.conf.urls import url, include
from django.contrib import admin from django.contrib import admin
urlpatterns = [ urlpatterns = [
# url(r'^help/', include('help.urls')), url(r'^help/', include('help.urls')),
url(r'^users/', include('users.urls')), url(r'^users/', include('users.urls')),
# url(r'^guestbook/', include('guestbook.urls')), url(r'^guestbook/', include('guestbook.urls')),
url(r'^admin/', admin.site.urls), url(r'^admin/', admin.site.urls),
] ]

20
ttadmin/users/admin.py
View File

@ -9,27 +9,19 @@ class PubkeyInline(admin.TabularInline):
model = Pubkey model = Pubkey
extra = 1 extra = 1
def bulk_accept(madmin, req, qs): def bulk_review(madmin, req, qs):
for townie in qs: for townie in qs:
townie.state = Townie.ACCEPTED townie.reviewed = True
townie.save() townie.save()
post_users_to_social(qs) post_users_to_social(qs)
bulk_accept.short_description = 'mark selected townies as accepted' bulk_review.short_description = 'mark selected townies as reviewed'
def bulk_reject(madmin, req, qs):
for townie in qs:
townie.state = Townie.REJECTED
townie.save()
bulk_reject.short_description = 'mark selected townies as rejected'
@admin.register(Townie) @admin.register(Townie)
class TownieAdmin(admin.ModelAdmin): class TownieAdmin(admin.ModelAdmin):
inlines = [PubkeyInline] inlines = [PubkeyInline]
list_display = ('username', 'state', 'email') list_display = ('username', 'reviewed', 'email')
readonly_fields = ('reasons', 'plans', 'socials') ordering = ('reviewed',)
ordering = ('state',)
exclude = ('first_name', 'last_name', 'password', 'groups', 'user_permissions', 'last_login', 'is_staff', 'is_active', 'is_superuser') exclude = ('first_name', 'last_name', 'password', 'groups', 'user_permissions', 'last_login', 'is_staff', 'is_active', 'is_superuser')
actions = (bulk_accept, bulk_reject,) actions = (bulk_review,)
search_fields = ('username', 'email', 'displayname') search_fields = ('username', 'email', 'displayname')

8
ttadmin/users/forms.py
View File

@ -12,9 +12,9 @@ submission_throttle = {}
throttle_submission = throttler(submission_throttle) throttle_submission = throttler(submission_throttle)
USERNAME_RE = re.compile(r'^[a-z][a-z0-9_]+$') USERNAME_RE = re.compile(r'[a-z][a-z0-9_]+')
USERNAME_MIN_LENGTH = 2 USERNAME_MIN_LENGTH = 3
DISPLAY_NAME_RE = re.compile(r"^[a-zA-Z0-9_\-']+$") DISPLAY_NAME_RE = re.compile(r"[a-zA-Z0-9_\-']+")
DISPLAY_MIN_LENGTH = 2 DISPLAY_MIN_LENGTH = 2
@ -23,7 +23,7 @@ def validate_username(username):
raise ValidationError('Username too short.') raise ValidationError('Username too short.')
if not USERNAME_RE.match(username): if not USERNAME_RE.match(username):
raise ValidationError('Username must be all lowercase, start with a letter, and only use the _ special character') raise ValidationError('Username must be all lowercase, start with a letter, and only use the _ special character')
duplicate = Townie.objects.filter(username=username).exclude(state=Townie.REJECTED).count() duplicate = Townie.objects.filter(username=username).count()
if duplicate > 0: if duplicate > 0:
raise ValidationError('Username already in use :(') raise ValidationError('Username already in use :(')

25
ttadmin/users/migrations/0012_auto_20190710_1622.py
View File

@ -1,25 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-10 16:22
from __future__ import unicode_literals
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('users', '0011_auto_20190416_0126'),
]
operations = [
migrations.AddField(
model_name='townie',
name='notes',
field=models.TextField(blank=True, null=True),
),
migrations.AlterField(
model_name='townie',
name='referral',
field=models.CharField(blank=True, max_length=100, null=True),
),
]

25
ttadmin/users/migrations/0013_auto_20190716_0148.py
View File

@ -1,25 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-16 01:48
from __future__ import unicode_literals
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('users', '0012_auto_20190710_1622'),
]
operations = [
migrations.AddField(
model_name='townie',
name='state',
field=models.CharField(choices=[('3_rejected', 'Rejected'), ('2_accepted', 'Accepted'), ('0_unreviewed', 'Unreviewed'), ('4_permaban', 'Permanently Banned'), ('1_tempban', 'Temporarily Banned')], default='0_unreviewed', max_length=20),
),
migrations.AlterField(
model_name='townie',
name='notes',
field=models.TextField(blank=True, help_text='Use this field to share information about this user (reviewed or not) for other admins to see', null=True),
),
]

23
ttadmin/users/migrations/0014_auto_20190716_0151.py
View File

@ -1,23 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-16 01:51
from __future__ import unicode_literals
from django.db import migrations
def set_state(apps, _):
Townie = apps.get_model('users', 'Townie')
for townie in Townie.objects.all():
if townie.reviewed:
townie.state = '2_accepted'
townie.save()
class Migration(migrations.Migration):
dependencies = [
('users', '0013_auto_20190716_0148'),
]
operations = [
migrations.RunPython(set_state)
]

19
ttadmin/users/migrations/0015_remove_townie_reviewed.py
View File

@ -1,19 +0,0 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.2 on 2019-07-16 02:10
from __future__ import unicode_literals
from django.db import migrations
class Migration(migrations.Migration):
dependencies = [
('users', '0014_auto_20190716_0151'),
]
operations = [
migrations.RemoveField(
model_name='townie',
name='reviewed',
),
]

74
ttadmin/users/models.py
View File

@ -10,7 +10,7 @@ from django.contrib.auth.models import User
from django.db.models import TextField, BooleanField, CharField, ForeignKey from django.db.models import TextField, BooleanField, CharField, ForeignKey
from django.template.loader import get_template from django.template.loader import get_template
from common.mailing import send_email from common.mailing import send_email, ADMIN_NAME
from help.models import Ticket from help.models import Ticket
logger = logging.getLogger() logger = logging.getLogger()
@ -19,7 +19,6 @@ SSH_TYPE_CHOICES = (
('ssh-rsa', 'ssh-rsa',), ('ssh-rsa', 'ssh-rsa',),
('ssh-dss', 'ssh-dss',), ('ssh-dss', 'ssh-dss',),
('ecdsa-sha2-nistp256', 'ecdsa-sha2-nistp256'), ('ecdsa-sha2-nistp256', 'ecdsa-sha2-nistp256'),
('ssh-ed25519', 'ssh-ed25519'),
) )
DEFAULT_INDEX_PATH = '/etc/skel/public_html/index.html' DEFAULT_INDEX_PATH = '/etc/skel/public_html/index.html'
@ -43,54 +42,23 @@ class Townie(User):
class Meta: class Meta:
verbose_name = 'Townie' verbose_name = 'Townie'
verbose_name_plural = 'Townies' verbose_name_plural = 'Townies'
# the actual values here have a leading int for sorting :(
UNREVIEWED = '0_unreviewed'
TEMPBAN = '1_tempban'
ACCEPTED = '2_accepted'
REJECTED = '3_rejected'
PERMABAN = '4_permaban'
STATE_CHOICES = (
(REJECTED, 'Rejected'),
(ACCEPTED, 'Accepted'),
(UNREVIEWED, 'Unreviewed'),
(PERMABAN, 'Permanently Banned'),
(TEMPBAN, 'Temporarily Banned'),
)
shell = CharField(max_length=50, default="/bin/bash") shell = CharField(max_length=50, default="/bin/bash")
state = CharField(max_length=20, choices=STATE_CHOICES, default=UNREVIEWED) reviewed = BooleanField(default=False)
reasons = TextField(blank=True, null=False, default='') reasons = TextField(blank=True, null=False, default='')
plans = TextField(blank=True, null=False, default='') plans = TextField(blank=True, null=False, default='')
socials = TextField(blank=True, null=False, default='') socials = TextField(blank=True, null=False, default='')
referral = CharField(max_length=100, null=True, blank=True) referral = CharField(max_length=100, null=True, blank=True)
displayname = CharField(max_length=100, blank=False, null=False) displayname = CharField(max_length=100, blank=False, null=False)
notes = TextField(blank=True, null=True,
help_text='Use this field to share information about this user (reviewed or not) for other admins to see')
@property
def accepted(self):
return self.ACCEPTED == self.state
@property
def unreviewed(self):
return self.UNREVIEWED == self.state
@property @property
def home(self): def home(self):
return os.path.join('/home', self.username) return os.path.join('/home', self.username)
def generate_gift(self):
command = '/town/bin/generate_welcome_present.sh'
error = _guarded_run(['sudo', command, self.username])
if error:
logger.error(error)
return
def send_welcome_email(self): def send_welcome_email(self):
welcome_tmpl = get_template('users/welcome_email.txt') welcome_tmpl = get_template('users/welcome_email.txt')
context = { context = {
'username': self.username, 'username': self.username,
'admin_name': 'vilmibm', 'admin_name': ADMIN_NAME,
} }
text = welcome_tmpl.render(context) text = welcome_tmpl.render(context)
success = send_email(self.email, text, subject='tilde.town!') success = send_email(self.email, text, subject='tilde.town!')
@ -117,7 +85,7 @@ class Townie(User):
"""A VERY NOT IDEMPOTENT create function. Originally, I had ambitions """A VERY NOT IDEMPOTENT create function. Originally, I had ambitions
to have this be idempotent and able to incrementally update a user as to have this be idempotent and able to incrementally update a user as
needed, but decided that was overkill for now.""" needed, but decided that was overkill for now."""
assert(self.accepted) assert(self.reviewed)
dot_ssh_path = '/home/{}/.ssh'.format(self.username) dot_ssh_path = '/home/{}/.ssh'.format(self.username)
error = _guarded_run(['sudo', error = _guarded_run(['sudo',
@ -239,7 +207,7 @@ def on_pubkey_post_save(sender, instance, **kwargs):
townie = townie[0] townie = townie[0]
if townie.accepted: if townie.reviewed:
townie.write_authorized_keys() townie.write_authorized_keys()
@ -251,22 +219,12 @@ def on_townie_pre_save(sender, instance, **kwargs):
existing = Townie.objects.get(id=instance.id) existing = Townie.objects.get(id=instance.id)
# See if we need to create the user on disk. # See if we need to create this user on disk.
if existing.unreviewed and instance.accepted: if not existing.reviewed and instance.reviewed is True:
logger.info('Creating user {} on disk.'.format(instance.username)) logger.info('Creating user {} on disk.'.format(instance.username))
try: instance.create_on_disk()
instance.create_on_disk() instance.send_welcome_email()
instance.write_authorized_keys() instance.write_authorized_keys()
except Exception as e:
logger.error('Failed syncing user {} to disk: {}'.format(instance.username, e))
else:
instance.send_welcome_email()
instance.generate_gift()
return
else:
# This user state transition is currently undefined. In the future, we can check for things
# like bans/unbans and then take the appropriate action.
return return
# See if this user needs a rename on disk # See if this user needs a rename on disk
@ -293,3 +251,15 @@ def _guarded_run(cmd_args, **run_args):
issue_text='error while running {}: {}'.format( issue_text='error while running {}: {}'.format(
cmd_args, e)) cmd_args, e))
return e return e
# things to consider:
# * what happens when a user is marked as not reviewed?
# * does this signal user deletion? Or does literal Townie deletion signal
# "needs to be removed from disk"? I think it makes the most sense for the
# latter to imply full user deletion.
# * I honestly can't even think of a reason to revert a user to "not reviewed"
# and perhaps it's best to just not make that possible. for now, though, I
# think I can ignore it.
# * what happens when a user needs to be banned?
# * the Townie should be deleted via post_delete signal

2
ttadmin/users/templates/users/thanks.html
View File

@ -27,7 +27,7 @@
<li><a href="https://tilde.town/~kc/blackout/">black out</a></li> <li><a href="https://tilde.town/~kc/blackout/">black out</a></li>
<li><a href="https://tilde.town/~subtransience/machinecode/index.html">the machine room</a></li> <li><a href="https://tilde.town/~subtransience/machinecode/index.html">the machine room</a></li>
</ul> </ul>
<h2>or a <a href="https://cgi.tilde.town/users/random">random page</a></h2> <h2>or a <a href="https://tilde.town/cgi/random">random page</a></h2>
</td> </td>
<td style="padding:1em"> <td style="padding:1em">
<a href="http://giphy.com/gifs/cyndipop-golden-girls-bea-arthur-ToMjGpK80QLT7KLWPLO"> <a href="http://giphy.com/gifs/cyndipop-golden-girls-bea-arthur-ToMjGpK80QLT7KLWPLO">

9
ttadmin/users/views.py
View File

@ -12,17 +12,10 @@ from django.views.generic.edit import FormView
from .forms import TownieForm from .forms import TownieForm
from .models import Townie, Pubkey from .models import Townie, Pubkey
SIGNUPS_ENABLED = True
class SignupView(FormView): class SignupView(FormView):
form_class = TownieForm form_class = TownieForm
template_name = 'users/signup.html' template_name = 'users/signup.html'
extra_context = {"signups_enabled": False}
def get_context_data(self, **kwargs):
ctx = super().get_context_data(**kwargs)
ctx['signups_enabled'] = SIGNUPS_ENABLED
return ctx
@transaction.atomic @transaction.atomic
def form_valid(self, form): def form_valid(self, form):