DjangoUeditor3/DjangoUeditor/commands.py

# -*- coding: utf-8 -*-
from . import settings as USettings
from six.moves.urllib.parse import urljoin


class UEditorEventHandler(object):
    """用来处理UEditor的事件侦听"""

    def on_selectionchange(self):
        return ""

    def on_contentchange(self):
        return ""

    def render(self, editorID):
        jscode = """
            %(editor)s.addListener('%(event)s', function () {
                %(event_code)s
        });"""
        event_codes = []
        # 列出所有on_打头的方法，然后在ueditor中进行侦听
        events = filter(lambda x: x[0:3] == "on_", dir(self))
        for event in events:
            try:
                event_code = getattr(self, event)()
                if event_code:
                    event_code = event_code % {"editor": editorID}
                    event_codes.append(jscode % {"editor": editorID, "event": event[
                                       3:], "event_code": event_code})
            except:
                pass

        if len(event_codes) == 0:
            return ""
        else:
            return "\n".join(event_codes)


class UEditorCommand(object):
    """
    为前端增加按钮，下拉等扩展,
    """

    def __init__(self, **kwargs):
        self.uiName = kwargs.pop("uiName", "")
        self.index = kwargs.pop("index", 0)
        self.title = kwargs.pop("title", self.uiName)
        self.ajax_url = kwargs.pop("ajax_url", "")

    def render_ui(self, editor):
        """" 创建ueditor的ui扩展对象的js代码，如button,combo等  """
        raise NotImplementedError

    def render_ajax_command(self):
        """"生成通过ajax调用后端命令的前端ajax代码"""
        if not self.ajax_url:
            return ""

        return u"""
            UE.ajax.request( '%(ajax_url)s', {
                 data: {
                     name: 'ueditor'
                 },
                 onsuccess: function ( xhr ) {%(ajax_success)s},
                 onerror: function ( xhr ){ %(ajax_error)s }
            });
        """ % {
            "ajax_url": self.ajax_url,
            "ajax_success": self.onExecuteAjaxCommand("success"),
            "ajax_error": self.onExecuteAjaxCommand("error")
        }

    def render_command(self):
        """" 返回注册命令的js定义  """
        cmd = self.onExecuteCommand()
        ajax_cmd = self.render_ajax_command()
        queryvalue_command = self.onExecuteQueryvalueCommand()
        cmds = []
        if cmd or ajax_cmd:
            cmds.append( u"""execCommand: function() {
                    %(exec_cmd)s
                    %(exec_ajax_cmd)s
                }
            """ % {"exec_cmd": cmd, "exec_ajax_cmd": ajax_cmd},)

        if queryvalue_command:
            cmds.append(u"""queryCommandValue:function(){
                    %s
                }""" % queryvalue_command)
        if len(cmds) > 0:
            return u"""
            editor.registerCommand(uiName, {
                    %s
                });
            """ % ",".join(cmds)
        else:
            return ""

    def render(self, editorID):
        return u"""
        UE.registerUI("%(uiName)s", function(editor, uiName) {
            %(registerCommand)s
            %(uiObject)s
        },%(index)s,"%(editor)s");
        """ % {
            "registerCommand": self.render_command(),
            "uiName": self.uiName,
            "uiObject": self.render_ui(editorID),
            "index": self.index,
            "editor": editorID
        }

    def onExecuteCommand(self):
        """ 返回执行Command时的js代码 """
        return ""

    def onExecuteAjaxCommand(self, state):
        """ 返回执行Command时发起Ajax调用成功与失败的js代码 """
        return ""

    def onExecuteQueryvalueCommand(self):
        """" 返回执行QueryvalueCommand时的js代码 """
        return ""


class UEditorButtonCommand(UEditorCommand):

    def __init__(self, **kwargs):
        self.icon = kwargs.pop("icon", "")
        super(UEditorButtonCommand, self).__init__(**kwargs)

    def onClick(self):
        """"按钮单击js代码，默认执行uiName命令，默认会调用Command """
        return """
            editor.execCommand(uiName);
        """

    def render_ui(self, editorID):
        """         创建button的js代码:        """
        return """
            var btn = new UE.ui.Button({
                name: uiName,
                title: "%(title)s",
                cssRules: "background-image:url('%(icon)s')!important;",
                onclick: function() {
                    %(onclick)s
                }
            });
            return btn
        """ % {
            "icon": urljoin(USettings.gSettings.MEDIA_URL, self.icon),
            "onclick": self.onClick(),
            "title": self.title
        }


class UEditorComboCommand(UEditorCommand):

    def __init__(self, **kwargs):
        self.items = kwargs.pop("items", [])
        self.initValue = kwargs.pop("initValue", "")

        super(UEditorComboCommand, self).__init__(**kwargs)

    def get_items(self):
        return self.items

    def onSelect(self):
        return ""

    def render_ui(self, editorID):
        """         创建combo的js代码:        """
        return """
        var combox = new UE.ui.Combox({
            editor:editor,
            items:%(items)s,
            onselect:function (t, index) {
                %(onselect)s
            },
            title:'%(title)s',
            initValue:'%(initValue)s'
        });
        return combox;
        """ % {
            "title": self.title,
            "items": str(self.get_items()),
            "onselect": self.onSelect(),
            "initValue": self.initValue
        }


class UEditorDialogCommand(UEditorCommand):
    pass