2016-06-24

転ばぬ先の杖のような、システムのチェックと修正

仕事

最近は、5月に利用が終了したシステムを再利用するために設定変更作業をしつつ、プログラムをチェックしています。

不具合の報告があったわけではないので、プログラムのチェックはしなくてもよさそうです。
それでも、システムの利用開始後に得た新たな事項を反映すべきではないのかとチェックしています。

どんなことをチェックしているのか

ショートタグ(<?)が使われていないか。
同時に同一Webサイトの別システムを利用された場合の制御が行われているか。
POST動作の後に、フォームをリロードする動作をしていないか。
メールの送信は、PEAR::Mailを使っているか。
ボタンを誤って連続で押されないように、無効化処理をしているか。
データベースロックを行っていて、適切な位置で行われているか。

f:id:AJYA:20160624164528j:plain
photo credit: Lomac LM-80L Andy Walker with a Pico Ammeter ? 81_21 via photopin (license)

それぞれどんな理由でチェックしているのか

利用中のエディタがショートタグ(<??を許可していなくて、コードの色分けがされず読みづらいので、長い形式(<?php)のタグに置きかえています。
同時に同一のWebサイトの別のシステムを利用されると、セッションで保持している値が後からの値で上書きされてしまうので、エラーになるように修正します。
リロードすると、POST動作を再実行する際の警告メッセージが表示されるので、リロードではなく、GET動作をするように修正します。
mb_sendmail()でメール送信をしていたら、特定のユーザーだけメールの件名が文字化けする現象が発生しました。
PEAR::Mailでメール送信を行うように修正したら、文字化けしなくなったので修正しています。
ボタンを連続で押すつもりがなくても押してしまい、2重登録されるときがあるので、ボタンを無効にする処理を追加しています。
登録の上限に達していいたら、登録できないようにチェックしています。
データベースのロックがされていなくて、残り登録可能数が1のときに同時に登録をテストしたら、エラーになかった経験があります。
登録の上限チェックの開始時点で、データベースをロックするように修正しています。

過去のシステムの使いまわしといえども、使うたびになんらかの修正を加える手間がかかります。

2016-06-23

チェックボックスがOFFと無効の組み合わせで正しく動作しない現象を対策しました

仕事

既存のソースコードで以下の正しく動作しない現象を見つけ、修正しました。

現象

データベースに「0」とだけ保存されているはずのカラムに、「0,0」と保存されていました。

動作の流れ

直前にデータの更新操作をしたので、更新時にデータが誤ったデータで更新したと推測されました。

更新処理は、まず更新用のページに値を表示して、変更後のデータを入力してもらい、更新をします。
表示は、

データベースから値を取得する。
セッション変数に、データベースから取得した値を設定する。
セッション変数を表示する。

という処理をしています。

更新は、更新ボタンをクリックすると、

更新用ページのフォームからPOSTされた値を使って、セッション変数を更新する。
セッション変数の値を使って、データベースを反映する。

という処理をしています。

誤ってデータが更新された箇所は、1個目のチェックボックスがチェック状態で固定されていて、2個目以降はチェックをON／OFFできるようになっています。
0・変更不可
1・変更可能
2・変更可能

HTMLのソースコードは以下のようになっています。

<input type="checkbox" name="chk" value="0" checked="checked" disabled>0・変更不可
<input type="checkbox" name="chk" value="1">1・変更可能
<input type="checkbox" name="chk" value="2">2・変更可能

f:id:AJYA:20160623061034j:plain
photo credit: 2015 TechGirls at iD Tech Camp at American University via photopin (license)

原因

更新ボタンをクリックすると、更新用ページのフォームからPOSTされた値を使って、セッション変数を更新します。
チェックボックスの1個目は、選択状態ですがdisabledのために値がPOSTされません。
チェックボックスの2個目以降は、選択されていないと値がPOSTされません。

POSTされた値がないため、セッション変数はデータベースから読み込まれたときの値のまま「0」になります。
このセッション変数の値に対して、必ず「0」は選ばれているので、「0」を連結する処理が動作して、「0,0」という値を生成していました。
この値を使ってデータベースを更新していたので、該当のカラムに「0,0」と保存されていました。

対策

更新ボタンをクリックしたら、該当のセッション変数を初期化してから、POSTされた値を使って、セッション変数を更新するようにしました。
セッション変数が初期化されているので、POSTされた値が無い場合は、空文字に対して「0」を連結する処理が動作して、「0」になります。
POSTされた値がある場合(例えば2)は、空文字に対して「0」と「2」を連結する処理が動作して、「0,2」になります。
これで修正が完了しました。