12 |
Importing
13 |
You can import your bookmarks from Chrome, Firefox, Safari, Opera, Internet Explorer, as long as they're in the Netscape bookmark format. Your directories will be converted to tags automatically. If you have a bookmark inside the folders "Photography -> Music" it'll get the tags "Photography" and "Music". If you have a bookmark inside the folders "Music -> Photography", it will get the tags "Photography" and "Music" as well.
14 |
Adding bookmarks
15 |
URL
16 |
That's the link to your bookmarked site. If you copy and paste it, the title will be fetched from the page automatically and added to the Name field as long as it is blank.
17 |
Name
18 | The name of your bookmark.
19 |
Tags
20 |
Comma or space separated tags for your bookmark. "music, songwriting, people" tags a bookmark as "music", "songwriting" and "people". So does "music songwriting people". So does "music, songwriting people"!
21 |
Descriptions
22 |
When you add a bookmark, you can write a description for it using Markdown syntax.
23 |
Viewing bookmarks
24 |
You can sort bookmark listings by name or by date (most recent first).
25 | The description for a bookmark is hidden by default and can be seen by clicking on [+]. Clicking expand all will expand all descriptions, and collapse all will close all of them.
26 |
Privacy
27 |
Public profiles
28 |
If you set your profile to public, everyone can see your bookmarks unless they're tagged as "private".
29 |
Unlisted tags
30 |
If you prefix a tag with a dot, like ".notsosecret", bookmarks tagged with it won't show up if another user's browsing your tags or bookmarks, but you can still share links to that tag.
31 |
Private profiles
32 |
If you set your profile to private, nobody can see your bookmarks unless they're tagged as "public".
33 |
Contact / Contribute
34 |
If you need anything or have a suggestion just send an email to bmarks@felipecortez.net. bmarks is open-source software built with Python and Django. You can find all the code, suggest changes and contribute at GitHub.
35 |
No results found.
121 | {% endif %}
122 |
123 | {% endblock %}
124 |
--------------------------------------------------------------------------------
/app/marks/settings.py:
--------------------------------------------------------------------------------
1 | from .config import *
2 | import os
3 | import logging
4 |
5 | SECRET_KEY = "defaultkey"
6 |
7 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
8 |
9 | if os.environ.get("DJANGO_DEVELOPMENT") is not None:
10 | DEBUG = True
11 | else:
12 | DEBUG = False
13 |
14 | ALLOWED_HOSTS = ["127.0.0.1", ".bmarks.net"]
15 |
16 | INTERNAL_IPS = ["127.0.0.1",]
17 |
18 | AUTHENTICATION_BACKENDS = ["marksapp.backends.CaseInsensitiveModelBackend"]
19 |
20 | INSTALLED_APPS = [
21 | "marksapp.apps.MarksappConfig",
22 | "django.contrib.admin",
23 | "django.contrib.auth",
24 | "django.contrib.contenttypes",
25 | "django.contrib.sessions",
26 | "django.contrib.messages",
27 | "django.contrib.staticfiles",
28 | "django.contrib.postgres",
29 | "debug_toolbar",
30 | ]
31 |
32 | MIDDLEWARE = [
33 | "django.middleware.security.SecurityMiddleware",
34 | "django.contrib.sessions.middleware.SessionMiddleware",
35 | "django.middleware.common.CommonMiddleware",
36 | "django.middleware.csrf.CsrfViewMiddleware",
37 | "django.contrib.auth.middleware.AuthenticationMiddleware",
38 | "django.contrib.messages.middleware.MessageMiddleware",
39 | "django.middleware.clickjacking.XFrameOptionsMiddleware",
40 | "debug_toolbar.middleware.DebugToolbarMiddleware",
41 | ]
42 |
43 | ROOT_URLCONF = "marks.urls"
44 |
45 | TEMPLATES = [
46 | {
47 | "BACKEND": "django.template.backends.django.DjangoTemplates",
48 | "DIRS": [],
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 = "marks.wsgi.application"
62 |
63 |
64 | if "TRAVIS" in os.environ:
65 | print("Using Travis CI for testing")
66 |
67 | DATABASES = {
68 | "default": {
69 | "ENGINE": "django.db.backends.postgresql",
70 | "NAME": "test_db",
71 | "USER": "postgres",
72 | "PASSWORD": "",
73 | "HOST": "localhost",
74 | "PORT": "",
75 | }
76 | }
77 | else:
78 | DATABASES = {
79 | "default": {
80 | "ENGINE": "django.db.backends.postgresql",
81 | "NAME": DB_NAME,
82 | "USER": DB_USER,
83 | "PASSWORD": DB_PW,
84 | "HOST": "db",
85 | "PORT": DB_PORT,
86 | }
87 | }
88 |
89 | AUTH_PASSWORD_VALIDATORS = [
90 | {
91 | "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
92 | },
93 | {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
94 | {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
95 | {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
96 | ]
97 |
98 | LANGUAGE_CODE = "en-us"
99 |
100 | TIME_ZONE = "America/Recife"
101 |
102 | USE_I18N = True
103 |
104 | USE_L10N = True
105 |
106 | USE_TZ = True
107 |
108 | LOGIN_URL = "/login/"
109 |
110 | LOGIN_REDIRECT_URL = "/"
111 |
112 | LOGOUT_REDIRECT_URL = "/"
113 |
114 | STATIC_ROOT = (
115 | "/srv/www/marks/static/" if not DEBUG else os.path.join(BASE_DIR, "static")
116 | )
117 |
118 | STATIC_URL = "/static/"
119 |
120 | X_FRAME_OPTIONS = "DENY"
121 |
122 | SECURE_CONTENT_TYPE_NOSNIFF = not DEBUG
123 |
124 | SECURE_BROWSER_XSS_FILTER = not DEBUG
125 |
126 | SECURE_SSL_REDIRECT = False
127 |
128 | # SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTOCOL", "https")
129 |
130 | SESSION_COOKIE_SECURE = not DEBUG
131 |
132 | CSRF_COOKIE_SECURE = not DEBUG
133 |
134 | CSRF_COOKIE_HTTPONLY = not DEBUG
135 |
136 | LOGGING = {
137 | "version": 1,
138 | "disable_existing_loggers": False,
139 | "handlers": {"console": {"class": "logging.StreamHandler"}},
140 | "loggers": {
141 | "django": {
142 | "handlers": ["console"],
143 | "level": os.getenv("DJANGO_LOG_LEVEL", "INFO"),
144 | }
145 | },
146 | }
147 |
148 | DEBUG_TOOLBAR_CONFIG = {
149 | 'SHOW_TOOLBAR_CALLBACK': lambda request: DEBUG,
150 | }
151 |
--------------------------------------------------------------------------------
/app/marksapp/forms.py:
--------------------------------------------------------------------------------
1 | from django import forms
2 | from django.forms import ModelForm, CharField, ChoiceField
3 | from django.forms.widgets import TextInput
4 | from django.contrib.auth.models import User
5 | from marksapp.models import Bookmark, Tag, Profile
6 | from marksapp.misc import tag_regex
7 | import marksapp.views
8 | import re
9 |
10 | EMAIL_PLACEHOLDER_STR = "optional! just in case you forget your password"
11 |
12 |
13 | # https://github.com/wagtail/wagtail/issues/130#issuecomment-37180123
14 | # fucking colons...
15 | # hey maybe https://experiencehq.net/blog/better-django-modelform-html for placeholders
16 | class BaseForm(forms.Form):
17 | def __init__(self, *args, **kwargs):
18 | kwargs.setdefault(
19 | "label_suffix", ""
20 | ) # globally override the Django >=1.6 default of ':'
21 | super(BaseForm, self).__init__(*args, **kwargs)
22 |
23 | for field_name in self.fields:
24 | field = self.fields.get(field_name)
25 | if field:
26 | field.widget.attrs.update(
27 | {
28 | #'placeholder': field.label
29 | }
30 | )
31 |
32 |
33 | class BaseModelForm(forms.ModelForm):
34 | def __init__(self, *args, **kwargs):
35 | kwargs.setdefault(
36 | "label_suffix", ""
37 | ) # globally override the Django >=1.6 default of ':'
38 | super(BaseModelForm, self).__init__(*args, **kwargs)
39 |
40 | for field_name in self.fields:
41 | field = self.fields.get(field_name)
42 | if field:
43 | field.widget.attrs.update(
44 | {
45 | #'placeholder': field.label
46 | }
47 | )
48 |
49 |
50 | class CommaTags(TextInput):
51 | template_name = "comma_tags.html"
52 |
53 | def get_context(self, name, value, attrs):
54 | if value:
55 | objects = []
56 | value = ", ".join([tag.name for tag in value])
57 |
58 | context = super(TextInput, self).get_context(name, value, attrs)
59 | return context
60 |
61 |
62 | class BookmarkForm(BaseModelForm):
63 | tags = CharField(widget=CommaTags)
64 |
65 | class Meta:
66 | model = Bookmark
67 | fields = ["url", "name", "tags", "description"]
68 | widgets = {
69 | "description": forms.Textarea(attrs={"rows": 3, "placeholder": "optional"})
70 | }
71 |
72 | def save(self, commit=True, *args, **kwargs):
73 | m = super(BookmarkForm, self).save(commit=False, *args, **kwargs)
74 | form_tags = marksapp.views.tags_strip_split(self.cleaned_data["tags"])
75 | m.save()
76 | self.instance.tags.clear()
77 |
78 | for tag in form_tags:
79 | if re.match(tag_regex, tag):
80 | t = Tag.objects.get_or_create(name=tag)[0]
81 | m.tags.add(t)
82 | else:
83 | print("WRONG")
84 | print(self.instance.tags)
85 | return m
86 |
87 |
88 | class TagForm(BaseModelForm):
89 | class Meta:
90 | model = Tag
91 | fields = ["name"]
92 |
93 | def is_valid(self):
94 | valid = super(TagForm, self).is_valid()
95 |
96 | if not valid:
97 | for f_name in self.errors:
98 | print(f_name)
99 | return valid
100 |
101 | return True
102 |
103 |
104 | class RegistrationForm(BaseForm):
105 | username = CharField(label="Username", required=True)
106 | password = CharField(label="Password", required=True, widget=forms.PasswordInput)
107 | email = CharField(
108 | label="E-mail",
109 | required=False,
110 | widget=forms.TextInput(attrs={"placeholder": EMAIL_PLACEHOLDER_STR}),
111 | )
112 | visibility = ChoiceField(
113 | choices=Profile.visibility_choices,
114 | label="Default visibility",
115 | initial="PB",
116 | widget=forms.RadioSelect(),
117 | )
118 |
119 |
120 | class ProfileForm(BaseModelForm):
121 | class Meta:
122 | model = Profile
123 | fields = ["visibility"]
124 | widgets = {"visibility": forms.RadioSelect()}
125 |
126 |
127 | class UserForm(BaseModelForm):
128 | class Meta:
129 | model = User
130 | fields = ["email"]
131 | widgets = {
132 | "email": forms.TextInput(attrs={"placeholder": EMAIL_PLACEHOLDER_STR})
133 | }
134 |
135 |
136 | class NetscapeForm(forms.Form):
137 | file = forms.FileField()
138 |
139 |
140 | class ImportJsonForm(forms.Form):
141 | file = forms.FileField()
142 |
--------------------------------------------------------------------------------
/app/marksapp/templates/base.html:
--------------------------------------------------------------------------------
1 | {% spaceless %}
2 |
3 |
4 |
5 |