Windows Live Writerサポート（Meta Weblog API）をDjangoブログに追加します

数年前、私は幸運にもWordPressブログを持つことができました。 残念ながら、ブログは投稿データベース全体と同じように生き残れませんでしたが、ブログ自体についてではなく、すべての情報がどのように公開されたかについてお話したいと思います。 当時、Microsoftは最近Windows 7を立ち上げ、それと共にWindows Liveアプリケーションスイートをリリースしました。 だから私は見てみることにしました-このパッケージで何がおいしいですか？ 何よりも、私はWindows Live Writerアプリケーションが気に入りました。これは、テキストを入力および書式設定し、ブログに公開できるプログラムです。 ユーザーフレンドリーなインターフェース、多くの書式設定ツール、下書きをローカルに保存する機能など、私は恋に落ちました。 しばらくして、Windows Live Writerなしではブログを想像できませんでした。







数年が経ちました。 すでに書いたように、そのブログは消えることはなく、Python、そしてDjangoでのプログラミングに興味を持つようになりました。 フレームワークを研究する過程で、新しいブログを作成したいという要望がありましたが、今回-ソフトウェア部分を自分で書くために、Djangoの利点は簡単で楽しいものです。 そして今、ニュースのあるメインページ、いくつかのセクション、コメントのサポートなどが登場しましたが、何かが欠けていました-便利な編集とテキストの公開。 ここでWindows Live Writerを思い出しました。 ブログに投稿するために使用できますか？ それが判明したように-私はできる、すべてが非常に簡単です。 デフォルトでは、アプリケーションはいくつかの人気のあるブログサービスへの公開のみをサポートしますが、新しいブログサービスの追加を妨げるものは何もありません-MetaWeblog APIに基づく公開をサポートするブログで十分です。 標準自体については説明しません。Wikiが私よりも優れているでしょう。 DjangoのあるサイトでMetaWeblogのサーバー側を実装する方法に焦点を当てます。 プロセス自体は非常に簡単ですが、判明したように、ロシア語のトピックに関する情報はあまりなく、ほとんどがPHPまたは.NETコードです。 このテキストは、決して完全なふりをしているわけではありません。私の目標は、私のような同じ初心者を正しい道筋に沿って誘導することです。そのため、次のことを理解するのは難しくありません。



それで、何が必要ですか？ まず、 XML-RPCサーバー（MetaWeblog APIはXML-RPCに基づいています）。 Pythonのデフォルトパッケージには十分なxmlrpclibが含まれていますが、サーバーがDjangoと直接対話する方が便利なように思えました。 しばらく検索した後、 django-xmlrpc-便利なサーバー-XML -RPCリクエストプロセッサが見つかりました。 ここで使用します。 インストールは簡単で、質問をするべきではありません。 インストールの最後のhttp：// domain / xmlrpc /で、登録済みメソッドのリストを確認できます。 主な設定は変数です

XMLRPC_METHODS。その定義は、setting.pyのどこかに配置する必要があります。これは、関数へのパス（ハンドラー、メソッドの名前）を含むカートリッジの集まりです。 例：

XMLRPC_METHODS = (('myproject.myapp.views.get_users_blogs', 'blogger.getUsersBlogs'),)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

したがって、関数がハンドラーであるblogger.getUsersBlogsというメソッドを登録しました。 なぜなら 将来、まったく同じ名前のメソッドが必要になります-登録することをお勧めします。



ここで、指定されたアドレスの関数に直接渡します。 デフォルトでは、Meta Weblog APIには、実装する必要のあるいくつかのメソッドがあり、具体的には次のとおりです。

• metaWeblog.newPost（）
• metaWeblog.getPost（）
• metaWeblog.editPost（）
• metaWeblog.getCategories（）
• metaWeblog.getRecentPosts（）
• metaWeblog.newMediaObject（）

メソッドによって受信および返されるデータの詳細については、たとえばこちらをご覧ください 。 ただし、メソッドも必要です。

• blogger.getUsersBlogs（）
• blogger.deletePost（）
• blogger.getUserInfo（）

ただし、最後の2つが必要であり、オプションである場合、最初のWindows Live Writerがなければ、サイトの登録を拒否します。 このため、blogger.getUsersBlogs（）から始めます。 そして、ここにハンドラーの機能コードがあります：

 from django_xmlrpc.decorators import xmlrpc_func @xmlrpc_func(returns='string', args=['string', 'string', 'string',]) def get_users_blogs(appKey, username, password): user = u_authenticate(username, password) return [{'isAdmin': user.is_superuser, 'url': 'http://127.0.0.1:8000/', 'blogid': '1', 'blogName': 'MyWebBlog'}]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コードはシンプルですが、コメントが必要です。 最初に目を引くのは、xmlrpc_funcデコレータです。 ご覧のとおり、2つのパラメーターがあり、1つ目はメソッドによって返されるデータのタイプを担当し、2つ目は受信したタイプを担当します。 なぜこのデコレータが必要なのですか？ メソッドにXML-RPC署名を追加します。 一般的に厳密に言えば、自由にそれを行うことができますが、クライアントアプリケーションはこのシグネチャを読み取ってメソッドに関する必要な情報を取得できます。 さて、何に対してごめんなさいと付け加えましょうか？



関数自体は3つのパラメーターを取ります。

1. appKey-アプリケーションの一意のキー-クライアント、私たちはそれを使用しません。
2. ユーザー名 -サービスのユーザー名
3. password-ユーザーパスワード。

u_authenticate関数は、データベースにデータベースがあれば、データベースからユーザーを返し、パスワードは正しいです。 検証要件に応じて、このような関数を自分で作成できますが、私が持っているものを使用できます：

 from xmlrpclib import Fault def u_authenticate(username, password): try: user = User.objects.get(username__exact=username) except User.DoesNotExist: raise Fault('1', 'Username is incorrect.') if not user.check_password(password): raise Fault('1', 'Password is invalid.') if not user.is_staff or not user.is_active: raise Fault('2', 'User account unavailable.') return user
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

FaultはXML-RPC Errorを生成します。その最初のパラメーターはエラーコード（任意、任意）、およびそのテキスト表現です。 問題が発生した場合にクライアントアプリケーションが表示するのは、このコードとテキストです。



get_users_blogs関数に戻り、データを返します。 ご覧のとおり、これは次の要素を持つ辞書を含むリストです。

1. isAdmin-ユーザーが管理者であるかどうかを示します。
2. url-ネットワーク上のブログのアドレスを直接
3. blogidは、サービス内のブログの一意のIDです。 サイトにいくつかのブログがある場合に必要です。 1つしかない場合は、たとえばゼロなど、任意の数で十分です。
4. blogName-ブログの名前は、クライアントアプリケーションで名前として使用されます。

コード内のURLとサイト名が厳密に指定されていることに注意してください。これはまったく当てはまりません。アドレスまたはサイト名を変更する場合、多くの関数のコードを変更する必要があります。 良いことには、そのようなものを設定内のどこかの別の変数に保存することをお勧めしますが、ここでは理解を簡単にするためにこのフォームにすべてを残しました。



これが実際にすべてです。 対話用のアドレスとしてhttp://127.0.0.1:8000/xmlrpc/のようなものを指定し、インターフェースとしてMeta Weblog APIを指定して、ブログをWindows Live Writerに追加してみてください。 すべてが正しく行われた場合、Windows Live Writerは自身でブログを登録し、公開前にプレビュー機能用にブログのビジュアルテーマ（html、css）をダウンロードすることを提案しますが、今は拒否する必要があります-トピックを決定するため、Windows Live Writerは一時的なブログを公開レコードを公開するためのメソッドmetaWeblog.newPost（）はまだ実装されていません。 さて、私たちは何を待っていますか？



同様に、まず、メソッドをXMLRPC_METHODSに追加します。

 ('myproject.myapp.views.new_post', 'metaWeblog.newPost')
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

それでは、関数を開始しましょう-ハンドラー：

 from datetime import datetime @xmlrpc_func(returns='string', args=['string', 'string', 'string', 'struct', 'boolean']) def new_post(blog_id, username, password, post, publish): user = u_authenticate(username, password) item = News() item.title = post['title'] item.text_news = post['description'] if post.get('dateCreated'): item.date = datetime.strptime(str(post['dateCreated']), '%Y%m%dT%H:%M:%S') else: item.date = datetime.now() item.author = user item.public = publish item.save() return item.pk
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コードも非常に単純ですが、念のためコメントします。

最初の3つの許容値は明確でなければなりません。残りの2つに焦点を当てます。

1. 投稿 -直接公開されたコンテンツ。 それは多くのものを含むことができる辞書です...デフォルトでは、これはもちろんタイトルです-レコードのタイトル、説明-メインテキスト、dateCreated-レコードが作成された日付、およびカテゴリ-レコードのタグ。 それでも、これはクライアントが提供する可能性のあるデータのごく一部にすぎず、たとえば、Windows Live Writerユーザーが日付の指定を忘れた場合、dateCreatedはまったく使用できない場合があります。 もちろん、これらすべてを考慮に入れ、あなたの目標/欲求に応じて使用する必要がありますが、投稿に表示される可能性のあるすべてのキーをリストするわけではありません。自分で確認する方が簡単です。 最終的に、自宅で使用するデータを決定するのはあなた次第です。
2. publish-ブール型の変数。投稿をすぐに公開する場合はTrue、ドラフトコピーに配置する場合はFalseです。

残りのコードは非常に単純です。 まず、ユーザーを認証します。 次に、ニュースの最も単純なNews（）モデルに基づいてアイテムオブジェクトが作成され、受信したデータが入力されます。 たぶん、item.dateで停止するだけの価値があるでしょう。 実際には、キーdateCreatedにはレコードの公開日時が含まれており、これは明らかにテキスト形式です。 そのため、文字列をコンポーネントに解析し、日付オブジェクトに変換する必要があります。 キーdateCreatedがまったくなかった場合、現在の日時が作成日時として指定されます。 繰り返しますが、これはニュースの最も単純なモデルであり、実際にはプロジェクトにもっと多くのデータがある可能性があります。 たとえば、カテゴリキーの処理はありません。 具体的には、このニュースモデルにはそれらがまったく含まれていませんが、必要な場合は誰も使用を禁止しません。



項目オブジェクトの入力が完了すると、データベースに保存され、関数はitem.pkを返します。 ここでは、さらに詳しく説明する価値があります。 newPost（）メソッドは、公開されたレコードの一意の識別子をクライアントに返すために必要です。これにより、将来、編集/削除のためにこのレコードを見つけることができるようになります。 pkをアイテムの一意の識別子として使用できますが、これは一般的にあまり良くありません。 事実は、pkは本質的に、公開時のデータベース内のレコードのシリアル番号であるということです。 ここで、Windows Live Writerを介して記録を公開し、Django管理パネルでそれを削除し、そこから新しい記録を投稿し、その後、Windows Live Writerを介して削除した記録を公開しようとするとどうなりますか？ しかし、単純なことが起こります。WindowsLive Writerは、レコードが発行の瞬間から既に削除されていることを知らず、別のレコードがその場所に表示されましたが、前のpkと同じです。 したがって、管理パネルを介して公開されたレコードは、Windows Live Writerから公開されるレコードによって書き換えられます。 人生では毎日そのような状況に対処する必要はないことは明らかですが、それにもかかわらず、pkよりもユニークな何かを返す価値があるようです。 それにも関わらず、pkを実証するには、目のために十分なものがあります。



それだけです。WindowsLive Writerにアクセスして、新しいエントリを公開する機会をお楽しみください:)。



また、以下のmetaWeblog.editPost（）およびblogger.deletePost（）メソッドの実装も提供します。 コードには具体的なものは何も含まれていないので、詳しくは説明しません。

 @xmlrpc_func(returns='boolean', args=['string', 'string', 'string', 'struct', 'boolean']) def edit_post(post_id, username, password, post, publish): user = u_authenticate(username, password) item = News.objects.get(id=post_id, author=user) item.title = post['title'] item.text_news = post['description'] if post.get('dateCreated'): item.date = datetime.strptime(str(post['dateCreated']), '%Y%m%dT%H:%M:%S') else: item.date = datetime.now().date() item.author = user item.public = publish item.save() return True @xmlrpc_func(returns='boolean', args=['string', 'string', 'string', 'string', 'string']) def delete_post(apikey, post_id, username, password, publish): print post_id user = u_authenticate(username, password) News.objects.get(id=post_id, author=user).delete() return True
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

両方の関数は、成功するとTrueを返します。 これで、問題なくブログのテーマをWindows Live Writerにダウンロードできます。上記の方法で十分です。



他のすべてのメソッドの実装については言及しません。 上記の情報はMeta Weblog APIの仕組みを理解するのに十分であり、必要なメソッドを実装することは難しくありません。 それだけです、今ではすべてです:)。 簡単ですが、Pythonのトピックに関するロシア語の情報が不足していること、およびサーバーライブラリが少し驚いたので、この記事でギャップを少し埋めることを望みます。 個人的には、使い慣れた便利なプログラムを使用して将来のブログにニュースを公開できるようになったことを嬉しく思います。また、Meta Weblog APIをサポートする別のクライアントをお勧めします。WindowsLive Writer ご清聴ありがとうございました。