|
"""Sqlalchemy Models for objects stored with Bookie"""
import logging
from BeautifulSoup import BeautifulSoup
from bookie.lib.urlhash import generate_hash
from datetime import datetime
from datetime import timedelta
from sqlalchemy import engine_from_config
from sqlalchemy import event
from sqlalchemy import Column
from sqlalchemy import DateTime
from sqlalchemy import Integer
from sqlalchemy import Unicode
from sqlalchemy import UnicodeText
from sqlalchemy import ForeignKey
from sqlalchemy import Table
from sqlalchemy import select
from unidecode import unidecode
from urlparse import urlparse
from sqlalchemy.exc import IntegrityError
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import aliased
from sqlalchemy.orm import contains_eager
from sqlalchemy.orm import joinedload
from sqlalchemy.orm import relation
from sqlalchemy.orm import scoped_session
from sqlalchemy.orm import sessionmaker
from sqlalchemy.orm import Query
from sqlalchemy.orm.exc import NoResultFound
from sqlalchemy.orm.collections import attribute_mapped_collection
from sqlalchemy.sql import func
from sqlalchemy.sql import and_
from zope.sqlalchemy import ZopeTransactionExtension
DBSession = scoped_session(sessionmaker(extension=ZopeTransactionExtension()))
Base = declarative_base()
LOG = logging.getLogger(__name__)
RECENT = 24 # number of hours to consider a bookmark as recent
def initialize_sql(settings):
"""Called by the app on startup to setup bindings to the DB"""
engine = engine_from_config(settings, 'sqlalchemy.')
DBSession.configure(bind=engine)
Base.metadata.bind = engine
import bookie.models.fulltext as ft
ft.set_index(settings.get('fulltext.engine'),
settings.get('fulltext.index'))
# setup the User relation, we've got import race conditions, ugh
from bookie.models.auth import User
if not hasattr(Bmark, 'user'):
Bmark.user = relation(User,
backref="bmark")
def todict(self):
"""Method to turn an SA instance into a dict so we can output to json"""
def convert_datetime(value):
"""We need to treat datetime's special to get them to json"""
if value:
return value.strftime("%Y-%m-%d %H:%M:%S")
else:
return ""
for col in self.__table__.columns:
if isinstance(col.type, DateTime):
value = convert_datetime(getattr(self, col.name))
else:
value = getattr(self, col.name)
yield(col.name, value)
def iterfunc(self):
"""Returns an iterable that supports .next()
so we can do dict(sa_instance)
"""
return self.__todict__()
def fromdict(self, values):
"""Merge in items in the values dict into our object
if it's one of our columns
"""
for col in self.__table__.columns:
if col.name in values:
setattr(self, col.name, values[col.name])
# Setup the SQLAlchemy database engine
Base.query = DBSession.query_property(Query)
Base.__todict__ = todict
Base.__iter__ = iterfunc
Base.fromdict = fromdict
bmarks_tags = Table(
'bmark_tags', Base.metadata,
Column('bmark_id', Integer, ForeignKey('bmarks.bid'), primary_key=True),
Column('tag_id', Integer, ForeignKey('tags.tid'), primary_key=True)
)
class InvalidBookmark(Exception):
"""Exception class for erroring when a bookmark is not a valid one."""
class TagMgr(object):
"""Handle all non-instance related tags functions"""
@staticmethod
def from_string(tag_str):
"""Split a list of tags in string form to instances
Currently it only supports space delimited
"""
if not tag_str or tag_str == '':
return {}
tag_list = set([tag.lower().strip() for tag in tag_str.split(" ")])
tag_objects = {}
for tag in TagMgr.find(tags=tag_list):
tag_objects[tag.name.lower()] = tag
tag_list.remove(tag.name.lower())
# any tags left in the list are new
for new_tag in (tag for tag in tag_list if tag != ""):
tag_objects[new_tag] = Tag(new_tag)
return tag_objects
@staticmethod
def find(order_by=None, tags=None, username=None):
"""Find all of the tags in the system"""
qry = Tag.query
if tags:
# limit to only the tag names in this list
qry = qry.filter(Tag.name.in_(tags))
if username:
# then we'll need to bind to bmarks to be able to limit on the
# username field
bmark = aliased(Bmark)
qry = qry.join((bmark, Tag.bmark)).\
filter(bmark.username == username)
if order_by is not None:
qry = qry.order_by(order_by)
else:
qry = qry.order_by(Tag.name)
return qry.all()
@staticmethod
def complete(prefix, current=None, limit=5, username=None):
"""Find all of the tags that begin with prefix
:param current: a list of current tags to compare with
If we provide a current then we should only complete tags that have
bookmarks with the current tag AND starts with the new prefix. In this
way when filtering tags we only complete things that make sense to
complete
"""
prefix = prefix.lower()
if current is None:
qry = Tag.query.filter(Tag.name.startswith(prefix))
# if we have a username limit to only bookmarks of that user
if username is not None:
qry = qry.filter(Tag.bmark.any(username=username))
qry = qry.order_by(Tag.name).limit(limit)
return qry.all()
else:
# things get a bit more complicated
"""
SELECT DISTINCT(tag_id), tags.name
FROM bmark_tags
JOIN tags ON bmark_tags.tag_id = tags.tid
WHERE bmark_id IN (
SELECT bmark_id FROM bmark_tags WHERE tag_id IN (
SELECT DISTINCT(t.tid) FROM tags t
WHERE t.name in ('vagrant', 'tips')
)
)
AND tags.name LIKE ('ub%');
"""
current_tags = DBSession.query(Tag.tid).\
filter(Tag.name.in_(current)).group_by(Tag.tid)
good_bmarks = DBSession.query(Bmark.bid)
if username is not None:
good_bmarks = good_bmarks.filter(Bmark.username == username)
good_bmarks = good_bmarks.\
filter(Bmark.tags.any(Tag.tid.in_(current_tags))).\
group_by(Bmark.bid)
query = DBSession.query(Tag.name.distinct().label('name')).\
filter(Tag.name.startswith(prefix)).\
filter(Tag.bmark.any(Bmark.bid.in_(good_bmarks)))
return DBSession.execute(query)
@staticmethod
def suggestions(bmark=None, recent=True, url=None, username=None):
"""Find suggestions for tags for a bookmark
The plan:
Suggest recent tags if there's a recent bookmark to pull tags from
Suggest related tags if there are other tags in bookmarks related
somehow (tbd)
Suggested other tags based on other people bookmarking this url
"""
tag_suggest = []
if recent:
# find the tags from the most recent bookmark if available
recent = BmarkMgr.get_recent_bmark(username=username)
if recent:
tag_suggest.extend(recent.tag_str.split(" "))
tag_list = list(set(tag_suggest))
return tag_list
@staticmethod
def count():
"""Count how many tags we have in the system"""
return Tag.query.count()
class Tag(Base):
"""Bookmarks can have many many tags"""
__tablename__ = "tags"
tid = Column(Integer, autoincrement=True, primary_key=True)
name = Column(Unicode(255), unique=True)
def __init__(self, tag_name):
self.name = tag_name.lower()
class ReadableMgr(object):
"""Handle non-instance model issues for readable"""
pass
class Readable(Base):
"""Handle the storing of the readable version of the page content"""
__tablename__ = 'bmark_readable'
bid = Column(Integer,
ForeignKey('bmarks.bid'),
primary_key=True)
hash_id = Column(Unicode(22),
ForeignKey('bmarks.hash_id'),
index=True)
content = Column(UnicodeText)
clean_content = Column(UnicodeText)
imported = Column(DateTime, default=datetime.utcnow)
content_type = Column(Unicode(255))
status_code = Column(Integer)
status_message = Column(Unicode(255))
def sync_readable_content(mapper, connection, target):
def _clean_content(content):
if content:
return u' '.join(BeautifulSoup(content).findAll(text=True))
else:
return u""
target.clean_content = _clean_content(target.content)
# Background the process of fulltext indexing this bookmark's content.
from bookie.bcelery import tasks
tasks.fulltext_index_bookmark.delay(
target.bmark.bid,
target.clean_content)
event.listen(Readable, 'after_insert', sync_readable_content)
event.listen(Readable, 'after_update', sync_readable_content)
class HashedMgr(object):
"""Manage non-instance methods of Hashed objects"""
def count():
"""Count how many unique hashed urls we've got."""
return Hashed.query.count()
@staticmethod
def get_by_url(url):
"""Return a hashed object for the url specified"""
res = Hashed.query.filter(Hashed.url == url).all()
if res:
return res[0]
else:
return False
class Hashed(Base):
"""The hashed url string and some metadata"""
__tablename__ = "url_hash"
hash_id = Column(Unicode(22), primary_key=True)
url = Column(UnicodeText)
clicks = Column(Integer, default=0)
def __init__(self, url):
"""We'll auto hash the id for them and set this up"""
cleaned_url = str(unidecode(url))
self.hash_id = generate_hash(cleaned_url)
self.url = url
class BmarkMgr(object):
"""Class to handle non-instance Bmark functions"""
@staticmethod
def get_by_url(url, username=None):
"""Get a bmark from the system via the url"""
# normalize the url
clean_url = BmarkTools.normalize_url(url)
qry = Bmark.query.join(Bmark.hashed).\
options(contains_eager(Bmark.hashed)).\
filter(Hashed.url == clean_url)
if username:
qry = qry.filter(Bmark.username == username)
return qry.one()
@staticmethod
def get_by_hash(hash_id, username=None):
"""Get a bmark from the system via the hash_id"""
# normalize the url
qry = Bmark.query.join(Bmark.hashed).\
options(contains_eager(Bmark.hashed)).\
filter(Hashed.hash_id == hash_id)
if username:
qry = qry.filter(Bmark.username == username)
return qry.first()
@staticmethod
def get_recent_bmark(username=None):
"""Get the last bookmark a user submitted
Only check for a recent one, last 3 hours
"""
last_hours = datetime.utcnow() - timedelta(hours=RECENT)
qry = Bmark.query.filter(Bmark.stored > last_hours)
if username:
qry = qry.filter(Bmark.username == username)
return qry.order_by(Bmark.stored.desc()).first()
@staticmethod
def find(limit=50, order_by=None, page=0, tags=None, username=None,
with_content=False, with_tags=True):
"""Search for specific sets of bookmarks"""
qry = Bmark.query
offset = limit * page
if with_content:
qry = qry.outerjoin(Bmark.readable).\
options(contains_eager(Bmark.readable))
if username:
qry = qry.filter(Bmark.username == username)
if order_by is None:
order_by = Bmark.stored.desc()
if not tags:
qry = qry.order_by(order_by).\
limit(limit).\
offset(offset).\
from_self()
if tags:
qry = qry.join(Bmark.tags).\
options(contains_eager(Bmark.tags))
if isinstance(tags, str):
qry = qry.filter(Tag.name == tags)
qry = qry.order_by(order_by).\
limit(limit).\
offset(offset).\
from_self()
else:
bids_we_want = select(
[bmarks_tags.c.bmark_id.label('good_bmark_id')],
from_obj=[
bmarks_tags.join(
'tags',
and_(Tag.name.in_(tags),
bmarks_tags.c.tag_id == Tag.tid)
).
join('bmarks', Bmark.bid == bmarks_tags.c.bmark_id)
]).\
group_by(bmarks_tags.c.bmark_id, Bmark.stored).\
having(
func.count(bmarks_tags.c.tag_id) >= len(tags)
).order_by(Bmark.stored.desc())
qry = qry.join(
(
bids_we_want.limit(limit).offset(offset).alias('bids'),
Bmark.bid == bids_we_want.c.good_bmark_id
)
)
# now outer join with the tags again so that we have the
# full list of tags for each bmark we filterd down to
if with_tags:
qry = qry.outerjoin(Bmark.tags).\
options(contains_eager(Bmark.tags))
# join to hashed so we always have the url
# if we have with_content, this is already done
qry = qry.options(joinedload('hashed'))
return qry.all()
@staticmethod
def user_dump(username):
"""Get a list of all of the user's bookmarks for an export dump usually
"""
return Bmark.query.join(Bmark.tags).\
options(
contains_eager(Bmark.tags)
).\
join(Bmark.hashed).\
options(
contains_eager(Bmark.hashed)
).\
filter(Bmark.username == username).all()
@staticmethod
def recent(limit=50, page=0, with_tags=False):
"""Get a recent set of bookmarks"""
qry = Bmark.query
offset = limit * page
qry = qry.order_by(Bmark.stored.desc()).\
limit(limit).\
offset(offset).\
from_self()
if with_tags:
qry = qry.outerjoin(Bmark.tags).\
options(contains_eager(Bmark.tags))
return qry.all()
@staticmethod
def popular(limit=50, page=0, with_tags=False):
"""Get the bookmarks by most popular first"""
qry = Hashed.query
offset = limit * page
qry = qry.order_by(Hashed.clicks.desc()).\
limit(limit).\
offset(offset).\
from_self()
bmark = aliased(Bmark)
qry = qry.join((bmark, Hashed.bmark)).\
options(contains_eager(Hashed.bmark, alias=bmark))
tags = aliased(Tag)
if with_tags:
qry = qry.outerjoin((tags, bmark.tags)).\
options(contains_eager(Hashed.bmark,
bmark.tags,
alias=tags))
res = qry.all()
return res
@staticmethod
def store(url, username, desc, ext, tags, dt=None, inserted_by=None):
"""Store a bookmark
:param url: bookmarked url
:param desc: the one line description
:param ext: the extended description/notes
:param dt: The original stored time of this bmark
:param fulltext: an instance of a fulltext handler
"""
parsed_url = urlparse(url)
if not parsed_url.netloc:
raise InvalidBookmark('The url provided is not valid: ' + url)
mark = Bmark(
url,
username,
desc=desc,
ext=ext,
tags=tags,
)
mark.inserted_by = inserted_by
DBSession.add(mark)
# if we have a dt then manually set the stored value
if dt is not None:
mark.stored = dt
return mark
@staticmethod
def hash_list(username=None):
"""Get a list of the hash_ids we have stored"""
qry = DBSession.query(Bmark.hash_id)
if username:
qry = qry.filter(Bmark.username == username)
return qry.all()
@staticmethod
def count(username=None, distinct=False):
"""How many bookmarks are there
:param username: should we limit to a username?
"""
qry = DBSession.query(Bmark.hash_id)
if username:
qry = qry.filter(Bmark.username == username)
if distinct:
qry = qry.distinct()
return qry.count()
class BmarkTools(object):
"""Some stupid tools to help work with bookmarks"""
@staticmethod
def normalize_url(url):
"""We need to clean the url so that we can easily find/check for dupes
Things to do:
- strip any trailing spaces
- Leave any query params, but think about removing common ones like
google analytics stuff utm_*
"""
# url = url.strip().strip('/')
return url
class Bmark(Base):
"""Basic bookmark table object"""
__tablename__ = "bmarks"
bid = Column(Integer, autoincrement=True, primary_key=True)
hash_id = Column(Unicode(22), ForeignKey('url_hash.hash_id'))
description = Column(UnicodeText())
extended = Column(UnicodeText())
stored = Column(DateTime, default=datetime.utcnow)
updated = Column(DateTime, onupdate=datetime.utcnow)
clicks = Column(Integer, default=0)
# this could be chrome_extension, firefox_extension, website, browser XX,
# import, etc
inserted_by = Column(Unicode(255))
username = Column(Unicode(255), ForeignKey('users.username'),
nullable=False,)
# DON"T USE
tag_str = Column(UnicodeText())
tags = relation(
Tag,
backref="bmark",
collection_class=attribute_mapped_collection('name'),
secondary=bmarks_tags,
lazy='joined',
innerjoin=False,
)
hashed = relation(Hashed,
backref="bmark",
uselist=False
)
readable = relation(Readable,
backref="bmark",
cascade="all, delete, delete-orphan",
primaryjoin="Readable.bid == Bmark.bid",
uselist=False)
def __init__(self, url, username, desc=None, ext=None, tags=None):
"""Create a new bmark instance
:param url: string of the url to be added as a bookmark
:param desc: Description field, optional
:param ext: Extended desc field, optional
:param tags: Space sep list of Bookmark tags, optional
"""
# if we already have this url hashed, get that hash
existing = HashedMgr.get_by_url(url)
if not existing:
self.hashed = Hashed(url)
else:
self.hashed = existing
self.username = username
self.description = desc
self.extended = ext
# tags are space separated
if tags:
self.tags = TagMgr.from_string(tags)
else:
self.tags = {}
def __str__(self):
return "<Bmark: {0}:{1}>".format(self.bid, self.hashed.url)
def tag_string(self):
"""Generate a single spaced string of our tags"""
return " ".join([tag for tag in self.tags.iterkeys()])
def update_tags(self, tag_string):
"""Given a tag string, split and update our tags to be these"""
self.tags = TagMgr.from_string(tag_string)
def bmark_fulltext_tag_str_update(mapper, connection, target):
"""Update things before insert/update for fulltext needs"""
target.tag_str = target.tag_string()
event.listen(Bmark, 'before_insert', bmark_fulltext_tag_str_update)
event.listen(Bmark, 'before_update', bmark_fulltext_tag_str_update)
def bmark_fulltext_insert_update(mapper, connection, target):
"""Update things before insert/update for the fulltext needs
"""
content = u""
if target.readable and target.readable.clean_content:
content = target.readable.clean_content
# Background the process of fulltext indexing this bookmark's content.
from bookie.bcelery import tasks
tasks.fulltext_index_bookmark.delay(target.bid, content)
event.listen(Bmark, 'after_insert', bmark_fulltext_insert_update)
event.listen(Bmark, 'after_update', bmark_fulltext_insert_update)
|
