Software development of explosion! -夢の破片(カケラ)たちの日々-

ソフトウェア開発を中心としたコンピューター関連のネタを扱ったブログです

Software development is passion and explosion!

Logbackからjava.util.loggingへログ出力するAppender

Logback 0.9.24からjava.util.logging.Loggerへ出力するためのAppenderです。
旧ブログのこの記事で公開したものを最新の0.9.24に対応させたものです。
前回同様Apache License 2.0です。こちらからライセンスをダウンロードしてください。(いい加減、ちゃんとした方法考えないとなぁ。Google Codeを使うとか)

/*
 * Copyright 2010 PoaD.
 * 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package tv.dyndns.poad.commons.logging.logback;

import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import ch.qos.logback.classic.spi.LoggingEvent;
import ch.qos.logback.core.Layout;
import ch.qos.logback.core.UnsynchronizedAppenderBase;

/**
 * <p>
 * 出力要求された内容を<code>java.util.logging.Logger</code>に出力するlogbackのAppender。
 * </p>
 * logbackのAppenderだが、java.util.logging(以下、jul)に出力しているため、
 * logbackの設定の他に、julの設定が必要となる。 </p>
 * <p>
 * 設定内容は、julのカテゴリー名(Logger名?)およびlogbackのAppenderに「tv.dyndns.poad.logging.logback
 * .JDKLogAppender」(このAppenderの名前)をする。<br />
 * <code>tv.dyndns.poad.logging.logback.JDKLogAppender.level = ALL<br>
 * &lt;appender name="STDOUT" class="tv.dyndns.poad.logging.logback.JDKLogAppender"&gt;</code>
 * といったように設定をし、他はlogbackの設定だけで動くはず。
 * </p>
 * 
 * @version $Rev$
 * @author $Author$
 * @param <E>
 **/
public class JDKLogAppender<E> extends UnsynchronizedAppenderBase<E> {
    @SuppressWarnings("serial")
    static Map<ch.qos.logback.classic.Level, Level> levelMap =
        new HashMap<ch.qos.logback.classic.Level, Level>() {
            {
                this.put(
                    ch.qos.logback.classic.Level.ERROR,
                    java.util.logging.Level.SEVERE);
                this.put(
                    ch.qos.logback.classic.Level.WARN,
                    java.util.logging.Level.WARNING);
                this.put(
                    ch.qos.logback.classic.Level.INFO,
                    java.util.logging.Level.INFO);
                this.put(
                    ch.qos.logback.classic.Level.DEBUG,
                    java.util.logging.Level.FINE);
                this.put(
                    ch.qos.logback.classic.Level.TRACE,
                    java.util.logging.Level.FINER);
            }
        };

    protected Layout<E> layout;

    /**
     * This default constructor does nothing.
     **/
    public JDKLogAppender() {
        // 何もしない
    }

    /**
     * Instantiate a JDKLogAppender and set the layout for this appender.
     * 
     * @param layout
     **/
    public JDKLogAppender(final Layout<E> layout) {
        this.setLayout(layout);
    }

    /**
     * @param layout
     **/
    public void setLayout(final Layout<E> layout) {
        this.layout = layout;
    }

    /*
     * (非 Javadoc)
     * 
     * @see
     * org.apache.log4j.AppenderSkeleton#append(org.apache.log4j.spi.LoggingEvent
     * )
     */
    @Override
    protected void append(final E event) {
        if (event instanceof LoggingEvent) {
            final LoggingEvent levent = (LoggingEvent) event;
            Logger.getLogger(JDKLogAppender.class.getName()).log(
                levelMap.get(levent.getLevel()),
                this.trimLineFeed(this.layout.doLayout(event)));
        }
    }

    /*
     * (非 Javadoc)
     * The last line-feed character of passed String is trimmed and it returns
     * it.
     * 
     * @param string
     * 
     * @return String to which the last line-feed character is trimmed.
     */
    private String trimLineFeed(final String string) {
        if (string.charAt(string.length() - 1) == '\n') {
            return string.substring(0, string.length() - 2);
        }
        return string;
    }
}

こんなのを作って使ったり、こんなの(log4jからjava.util.logging.Loggerへ出力するためのAppender)を作って使ったりしているのは、Google App Engineのコンソールにはき出されるログが、PDT(サマータイムから切り替わったらまた時差が変わるんだろうなぁ)だったりするので分かりづらい。
かといって、Logbacklog4jのConsoleAppenderだと、今度はコンソール側でのログレベルが同じになってしまう(STDOUTやらSTDERRORにはき出されるからね)。
なので、どうしてもjava.util.logging.Loggerからはき出さないとならないのだけれどもPatternを設定しても動いてくれないから、log4jlogbackを使って無理矢理JSTの時間をくっつけて吐き出させているわけです。

っていうか、管理コンソール側で表示を切り替えられたりすればいいのに…

PayPal のIPNでハマった

仕事でGoogle Apps Marketplace向けアプリを開発していて、PayPalで売り切り(って言うの?)で課金しようとしているのですが、IPN通知の処理でハマった…OTL

そもそも、IPN通知が何かと言うと、即時支払い通知といい、WebHooksというヤツなのでしょうか?ユーザーさんがPayPal経由で商品を購入した際や、何らかの理由でマーチャント(販売者)が返金した際などに、あらかじめ指定されたURLに対して、Paypalから通知が来るというものです。

通知先は、PayPalのマーチャント側の設定画面で設定するか、PayPalで購入するための購入ボタンがクリックされた際に、PayPalへPOSTメソッドでリクエストを発行してユーザーさんに手続きを開始させるのですが、その際にHTML変数(リクエストパラメーター)に「notify_url」という形で、URLを指定します。
前者は、IPNを有効にする際に入力する必要があり、後者は、任意で指定可能で、指定すると、その取引に対してのIPNによる通知は、HTML変数で指定されたURLへと通知されるようになります。
IPNリスナー(IPN通知を受け取る側)のサンプルコードは、PayPalのサイトで公開されているので、細かい話は割愛するとして、ここにも書かれているように、

  1. ポストバックを行って、PayPalに正しい通知か否かを判定してもらう
  2. payment_statusが「Completed」か否か
  3. txn_idが処理済みの過去のデータと比較し、重複していないか
  4. 商品名item_name、価格mc_gross、通貨mc_currencyなどが正しいかどうか

といったことを行う必要があるのですが…
先ず、ポストバック。Javaのサンプルコードをそのまま使っても、上手く動きませんでした。
いや、正確にはサンプルコードは間違ってはいないのですが、何度やってもpayment_statusが「Pending」、payment_reasonが「unilateral」になってしまう。

原因は、メールアドレスが認証されていなかったからなのですが、

手順は

  1. 「マイアカウント」
  2. 「個人設定」
  3. 「メールアドレスの登録または編集」(※)
  4. メールアドレスを選択して「確認」

とすると、PayPalからメールが来るので、そのメールの中に書かれているアドレスで解決出来ました。
※ 名称はプルダウンの場合であり、「個人設定」の画面からは「アカウント情報」の項目の欄の「メールアドレス」となる。

まぁ、PayPalのドキュメントにも書いてありますが、そんな手続きが必要なんて書いてなかったような…

次にハマったのが、文字のエンコードです。
PayPalのサイトで(勿論、SandBoxでテストしているならSandBoxで)、設定を変えないとShift_JISになってしまうのですが、

  1. 「マイアカウント」
  2. 「個人設定」

と進み、「販売の設定」の欄にある「言語のエンコード」を選択して「ウェブサイトの言語」を「日本語」にします。
そして、「詳細オプション」に進みます。
この「詳細オプション」に落とし穴があって、

  • エンコード方式」を「UTF-8
  • PayPalから送信されたデータと同じエンコード方式を使用しますか(IPN、ダウンロード可能なログ、メールなど)?」を「はい」

にすると、前の画面の「ウェブサイトの言語」の設定が何故か「西欧言語(英語を含む)」になってしまいます。
これに気づかずに、IPN通知をポストバックしてみたら、ものの見事にINVALIDとなってしまいました。
(UTF-8て日本語使えるのにね。3バイトとかの文字もあるけど)

そこで、先ほどの「詳細オプション」では、

  • エンコード方式」を「Shift_JIS
  • PayPalから送信されたデータと同じエンコード方式を使用しますか(IPN、ダウンロード可能なログ、メールなど)?」を「いいえ。次のエンコード方式を使用します。」
  • その下のプルダウンで「UTF-8」を選択して「保存」とします。

そうしたら、ものの見事に解決出来ました。

まぁ、その後でハマったのが、payment_statusが「Refunded」(払い戻し)の際に、商品価格が負の値(払い戻す額がそのまんまマイナス)で通知されてきてくれて、「Completed」でない場合にも価格(mc_gross)が購入ボタンの作成時に設定した価格か否かの判定をしていたのでエラーになってくれました。
「Completed」以外の場合はチェックせずに、そのままこちらのサーバー側に保存しちゃっていいのかな?(一応、価格 >= mc_gross >= -価格 という判定にしてみたけど大丈夫かな?)

あと、気になるのが、ポストバックでエラーになった場合はPDF版のドキュメントに「不正な取引の可能性があるため調査してくれ」みたいなことが書いてあったのでいいのですが、ポストバックは正常だけど「商品名item_name、価格mc_gross、通貨mc_currencyなどが正しいかどうか」で正しくなかった場合のエラー処理はどうしたらいいのだろう?

PayPal側に何かするとかしなくてもいいのかな?一応、マーチャントの管理側にメール通知出来るようなアプリの仕様にはしてみたけど。

FC2でコードハイライトがどうやっても使えないとかって思っていたら・・・使えた

google-code-prettify を、ブログで使いたいと思っていたのだけれども、
以前、FC2で試そうとしていたらやり方が分からなくて出来ないのだろうと思い込んでしまっていた。
そういう理由もあって(それだけじゃないけど)はてなダイアリーに引っ越してきたのだけれども、
はてなじゃぁ、スーパーpre記法が使える代わりにgoogle-code-prettifyは使えなかった。
で、何となくFC2の方(今後、FC2の方には新しい記事を追加することはないと思う)の設定を見ていたら、
HTMLテンプレートを編集する設定項目を見つけたので埋め込んでみた。

最初は、JavaScriptをテンプレート直に組み込もうとしたらレイアウトが崩れてしまった。
そこで、ファイルアップロードって画像だけかな?と思って開いてみたら、CSSもJSも対応してる。

なので、素直にCSSとJSをアップロードして、HTMLテンプレートからlinkタグやscriptタグを使って参照させるようにしたら動いてくれました。

う〜ん・・・はてなでもgoogle-code-prettifyを使いたいなぁ。配色だとか細かい部分のハイライト表示なんかは個人的にはgoogle-code-prettifyの方がいいと思う。

Google App Engine で logback 0.9.24 を使う

Google App Engine で 最新のlogback 0.9.24(恐らく0.9.19〜0.9.24はすべて)を動かすためのパッチ(?)を見つけたので載せておきます。
java.net.InetAddress を使わないようにするだけみたいです。

package ch.qos.logback.core.util; 
import ch.qos.logback.core.Context; 
import ch.qos.logback.core.CoreConstants; 
import ch.qos.logback.core.spi.ContextAwareBase; 
public class ContextUtil extends ContextAwareBase { 
        public ContextUtil(Context context) { 
                setContext(context); 
        } 
        /** 
         * Add the local host's name as a property 
         */ 
        public void addHostNameAsProperty() { 
                context.putProperty(CoreConstants.HOSTNAME_KEY, "yourhostname"); 
        } 
} 

あとは、logbackからjava.util.logging へブリッジするAppender(ベースはこれ。確か、最新版だとLayoutとかその辺をAppender内で処理するとかしないと駄目だったはず。今、ソースが手元に無いので、最新版は明日以降)を使えば、とりあえずはいいとは思うのだけれども…
Google App Engine for Java用ロギングフレームワークを誰か作ってくれないものか…コンソールのレベルと照らし合わせるのが面倒なんだよね。java.util.loggingでも同じだけどさ。

あれだ、よく考えたら、GoogleがLoggingServiceを作って提供してくれたらいいんだ。どうせ、java.util.loggingだってプロダクション環境では中身はオリジナルなんだろうから。(Patternクラス作ってlogging.propertiesで指定してもプロダクション環境だと動かないしね。)

Google Apps MarketplaceのSave and Preview

仕事でGoogle Apps Marketplaceを使ってInstallableアプリを公開しようとしているのですが、
Google Apps Marketplaceに関して、ずっと前から気になっていたことがありました。

一番最初のリスティングの際に、$100の課金が発生するのだけれども、「掲載するアプリのテストって$100をGoogleに支払った後じゃないと出来ないの?」です。
Twitterで@shin1ogawa さんに、「$100を支払う前にも出来ますよ。」と教えていただいていたのですが、どこからやれば出来るのか分からなかったのです。

原因は、リスティングまでの手順で「Save and Preview」をクリックしたら課金手続きに入るものだと思っていてクリック出来ないでいたのです。
課金されてもいいや!と思って試しに、Google Apps Marketplace企業向けアプリ出店入門(1/2) ─ @IT を参考に「Save and Preview」までやってみました。

f:id:poad1010:20100921101828j:image

「Save and Preview」をクリックすると、上の画像のようなリスティング(って言うのだろうな)のプレビュー画面が表示されて、ここから「Add it now」のテストが出来ます。
※ このタイミングでは課金されず、「I am ready! Submit this listing approval」をクリックした際に課金手続きに入ります。

「Save and Preview」で入力データが保存されるのですが、保存されたデータがあると、ベンダープロフィールの画面に下の図のように、リスティングの一覧のようなものが表示されます。

f:id:poad1010:20100921101829j:image

「View OAuth Consumer Key »」のリンクもあって、クリックすると2LOに必要なConsumer Key/Secretが表示される他、Apps Marketplace上でのアプリケーションIDも表示されます。

FC2から移転してきました

FC2から移転してきました。アメブロに移転させようかと思ったけど、引っ越しとか上手く動かなかったのと、アメーバのサービス自体、あまり使ったことがないのと、多分、ソースコードとか載せるのにいいかなぁと思ったのでとりあえずこっちにしました。


ちなみに旧ブログは夢の破片(カケラ)たちな日々