Feature notify (#18)

* feat: 添加诗词插件

Author: colorful3

Pipfile

@@ -11,7 +11,8 @@ cymysql = "==0.9.1"
 flask-cors = "==2.1.0"
 requests = "==2.18.4"
 pipfile = "*"
-lin-cms = "==0.1.1a3"
+lin-cms = "==0.1.1a2"
+"oss2" = "*"
 
 [dev-packages]
 pytest = "*"

app/api/v1/book.py

@@ -4,7 +4,8 @@
     :copyright: © 2019 by the Lin team.
     :license: MIT, see LICENSE for more details.
 """
-from lin import db, route_meta, group_required
+from lin import db, route_meta, group_required, login_required
+from lin.notify import Notify
 from lin.redprint import Redprint
 from flask import jsonify
 from lin.exception import NotFound, ParameterException, Success
@@ -16,7 +17,11 @@
 book_api = Redprint('book')
 
 
+# 注意：如果Notify添加的视图函数，没有添加任何视图函数，那么不可识别用户身份
+# 这与真实的情况是一致的，因为一般的情况下，重要的接口需要被保护，重要的消息才需要推送
 @book_api.route('/<id>', methods=['GET'])
+@login_required
+@Notify(template='{user.nickname}查询了一本图书', event='queryBook')
 def get_book(id):
     book = Book.query.filter_by(id=id).first()  # 通过Book模型在数据库中查询id=`id`的书籍
     if book is None:
@@ -25,8 +30,10 @@ def get_book(id):
 
 
 @book_api.route('/', methods=['GET'])
+@login_required
+@Notify(template='{user.nickname}查询了所有图书', event='queryBooks')
 def get_books():
-    books = Book.query.filter_by(delete_time=None).all()
+    books = Book.query.filter_by(soft=True).all()
     if books is None or len(books) < 1:
         raise NotFound(msg='没有找到相关书籍')
     return jsonify(books)

app/config/setting.py

@@ -14,5 +14,7 @@
 
 # 插件模块暂时没有开启，以下配置可忽略
 # plugin config写在字典里面
-BP_URL_PREFIX = '/plugin'
-PLUGIN_PATH = {}
+PLUGIN_PATH = {
+    'oss': {'path': 'app.plugins.oss', 'enable': True, 'upload_folder': 'app/static'},
+    'poem': {'path': 'app.plugins.poem', 'enable': True, 'limit': 5},
+}

app/plugins/.gitkeep

@@ -0,0 +1,2 @@
+from .controller import api
+from .model import Image

app/plugins/oss/app/__init__.py

@@ -0,0 +1,90 @@
+from flask import jsonify, request
+import os
+from lin.exception import Success, ParameterException, Failed
+from .oss import upload_image_bytes
+from .model import Image
+from .enums import LocalOrCloud
+from lin.db import db
+from lin.redprint import Redprint
+from lin.core import lin_config
+
+api = Redprint('oss')
+
+
+@api.route('/upload_to_local', methods=['POST'])
+def upload():
+    image = request.files.get('image', None)
+    if not image:
+        raise ParameterException(msg='没有找到图片')
+    if image and allowed_file(image.filename):
+        path = os.path.join(lin_config.get_config('oss.upload_folder'), image.filename)
+        image.save(path)
+    else:
+        raise ParameterException(msg='图片类型不允许或图片key不合法')
+    return Success()
+
+
+@api.route('/upload_to_ali', methods=['POST'])
+def upload_to_ali():
+    image = request.files.get('image', None)
+    if not image:
+        raise ParameterException(msg='没有找到图片')
+    if image and allowed_file(image.filename):
+        url = upload_image_bytes(image.filename, image)
+        if url:
+            res = {
+                'url': url
+            }
+            with db.auto_commit():
+                exist = Image.get(url=url)
+                if not exist:
+                    data = {
+                        'from': LocalOrCloud.CLOUD.value,
+                        'url': url
+                    }
+                    one = Image.create(**data)
+                    db.session.flush()
+                    res['id'] = one.id
+                else:
+                    res['id'] = exist.id
+            return jsonify(res)
+    return Failed(msg='上传图片失败，请检查图片路径')
+
+
+@api.route('/upload_multiple', methods=['POST'])
+def upload_multiple_to_ali():
+    imgs = []
+    for item in request.files:
+        img = request.files.get(item, None)
+        if not img:
+            raise ParameterException(msg='没接收到图片，请检查图片路径')
+        if img and allowed_file(img.filename):
+            url = upload_image_bytes(img.filename, img)
+            if url:
+                # 每上传成功一次图片需记录到数据库
+                with db.auto_commit():
+                    exist = Image.get(url=url)
+                    if not exist:
+                        data = {
+                            'from': LocalOrCloud.CLOUD.value,
+                            'url': url
+                        }
+                        res = Image.create(**data)
+                        db.session.flush()
+                        imgs.append({
+                            'key': item,
+                            'url': url,
+                            'id': res.id
+                        })
+                    else:
+                        imgs.append({
+                            'key': item,
+                            'url': url,
+                            'id': exist.id
+                        })
+    return jsonify(imgs)
+
+
+def allowed_file(filename):
+    return '.' in filename and \
+           filename.rsplit('.', 1)[1] in lin_config.get_config('oss.allowed_extensions', [])

app/plugins/oss/app/controller.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+# 图片保存在本地还是云端
+# 建议云端
+class LocalOrCloud(Enum):
+    LOCAL = 1
+    CLOUD = 2

app/plugins/oss/app/enums.py

@@ -0,0 +1,10 @@
+from lin.interface import BaseCrud
+from sqlalchemy import Column, Integer, String, FetchedValue
+
+
+class Image(BaseCrud):
+    __tablename__ = 'image'
+
+    id = Column(Integer, primary_key=True)
+    url = Column(String(255), nullable=False)
+    _from = Column('from', Integer, nullable=False, server_default=FetchedValue())

app/plugins/oss/app/model.py

@@ -0,0 +1,17 @@
+import oss2
+
+from lin.util import get_random_str
+from lin.core import lin_config
+
+
+def upload_image_bytes(name: str, data: bytes):
+    access_key_id = lin_config.get_config('oss.access_key_id')
+    access_key_secret = lin_config.get_config('oss.access_key_secret')
+    auth = oss2.Auth(access_key_id, access_key_secret)
+    bucket = oss2.Bucket(auth, lin_config.get_config('oss.endpoint'), lin_config.get_config('oss.bucket_name'))
+    suffix = name.split('.')[-1]
+    rand_name = get_random_str(15) + '.' + suffix
+    res = bucket.put_object(rand_name, data)
+    if res.resp.status == 200:
+        return res.resp.response.url
+    return None

app/plugins/oss/app/oss.py

@@ -0,0 +1,7 @@
+access_key_id = 'not complete'
+access_key_secret = 'not complete'
+endpoint = 'http://oss-cn-shenzhen.aliyuncs.com'
+bucket_name = 'not complete'
+
+upload_folder = 'app'
+allowed_extensions = ['jpg', 'gif', 'png', 'bmp']