Jul 03

PHP Trackback - Bir “Geri İzleme” sınıfı

PHP, Web Yorumunuz ?

PHP TrackbackGeri İzleme (Trackback) nedir? başlıklı yazımda, PHP Trackback adlı geri izleme sınıfından bahsedeceğimi söylemiştim. Bu sınıfı baştan sona inceleyerek, hem geri izleme teknolojisinin teknik altyapısını kavrayacağız, hem de bu tür bir sistemin PHP ile nasıl kodlanabileceğini görmüş olacağız.

Yazı; hem kodları yayınlamamdan, hem fonksiyonlardan ayrı ayrı bahsetmemden dolayı biraz uzun oldu. Kaynak kodları içinde örnekler olduğundan dolayı birkaç fonksiyon dışında bu örneklere yer vermedim, onları incelemeyi size bırakıyorum. Sizi daha fazla cümlelerle sıkmadan hemen sınıfı incelemeye başlıyorum...


Öncelikle sınıf hakkında genel bilgilerle konuya girelim. İsrail'de yaşayan Ran Aroussi adlı arkadaş tarafından kodlanan bu sınıf, geri izleme teknolojisinin hemen hemen bütün gereklerini yerine getirebiliyor. Sınıfın kod mimarisine baktığımızda ise PHP4 ile kodlandığını görüyoruz. PHP5'e geçen arkadaşların da dert etmesine gerek yok; PHP, geriye dönük uyumlu sürümler çıkardığı için bu sınıf, platform sorunu çıkarmayacaktır (Ben PHP5.2.x sunucu üzerinde denedim).

Sınıfın ingilizce olarak kaynak kodlarını görmek için tıklayınız...

Sınıfı indirmek için tıklayınız...

Ran Aroussi arkadaşımız kodları hazırlarken hem açıklamalarını kolay anlaşılır bir biçimde yazmış, hem de her fonksiyon için ayrı ayrı kullanım örnekleri iliştirmiş. İngilizcesi olan arkadaşlar rahatlıkla kaynak kodlarına bakarak sınıfı kullanabilir ama biz yine de tüm fonksiyonları ayrı ayrı inceleyeceğiz.

SINIFIN ÖZELLİKLERİ

PLAIN TEXT
PHP:
  1. /**
  2. * Geri izleme - Asıl sınıf
  3. *
  4. * @param string $blog_name
  5. * @param string $author
  6. * @param string $encoding
  7. */
  8. class Trackback {
  9. var $blog_name = ''; // Sınıf boyunca kullanılacak varsayılan günlük adı (örn. Shapcy.com)
  10. var $author = ''; // Sınıf boyunca kullanılacak varsayılan yazar adı (örn. Mustafa ŞAPÇILI)
  11. var $encoding = ''; // Sınıf boyunca kullanılacak varsayılan karakter kodlaması(örn. UTF-8)
  12. var $get_id = ''; // $_GET['id'] değerini geri alır ve tutar (boş değilse)
  13. var $post_id = ''; // $_POST['id'] değerini geri alır ve tutar (boş değilse)
  14. var $url = ''; // $_POST['url'] değerini geri alır ve tutar (boş değilse)
  15. var $title = ''; // $_POST['title'] değerini geri alır ve tutar (boş değilse)
  16. var $expert = ''; // $_POST['expert'] değerini geri alır ve tutar (boş değilse)
  17. /**
  18. * Sınıf yapıcısı
  19. *
  20. * @param string $blog_name
  21. * @param string $author
  22. * @param string $encoding
  23. * @return
  24. */
  25. function Trackback($blog_name, $author, $encoding = "UTF-8")
  26. {
  27. $this->blog_name = $blog_name;
  28. $this->author = $author;
  29. $this->encoding = $encoding;
  30.  
  31. // $_POST bilgisini topla
  32. if (isset($_GET['id'])) {
  33. $this->get_id = $HTTP_GET_VARS['id'];
  34. }
  35. if (isset($_POST['id'])) {
  36. $this->post_id = $HTTP_POST_VARS['id'];
  37. }
  38. if (isset($_POST['url'])) {
  39. $this->url = $HTTP_POST_VARS['url'];
  40. }
  41. if (isset($_POST['title'])) {
  42. $this->title = $HTTP_POST_VARS['title'];
  43. }
  44. if (isset($_POST['expert'])) {
  45. $this->expert = $HTTP_POST_VARS['expert'];
  46. }
  47. }

Dosyayı parça parça koyacağım. Bu yüzden söz dizimi hatası varmış gibi durabilir :) Sınıfımızın tanımıyla ve özellikleriyle başlıyoruz. Sınıfımız 3 değişkenle çağrılabiliyor: $blog_name, $author ve $encoding. Bunlar string tipinde veri taşıyor. 3 değişken ile çağrılabilmesini sağlayan yapılandırıcı fonksiyonumuz. Zaten görüldüğü gibi sınıfımız ile aynı isme sahip ve bu 3 değişkeni parametre olarak alıp sınıfımızın ilgili özelliklerine geçiriyor. Yapılandırıcı fonksiyonumuz bununla da kalmayıp diğer özellikler için gerekli veriler oluşturulmuşsa, onları da sınıfımızın özelliklerine geçiriyor. Özelliklerin bilgilerini, yanlarında açıklama olarak verdiğim için tekrar yazmıyorum.

Sınıfı oluşturmak için örnek vermek gerekirse:

PLAIN TEXT
PHP:
  1. <?php
  2. include('trackback_cls.php');
  3. $trackback = new Trackback('Shapcy.com', 'Mustafa ŞAPÇILI', 'UTF-8');
  4. ?>

Değinmek istediğim ufak bir nokta daha var. Orjinal kaynakta şu kısma bakarsak:

PLAIN TEXT
PHP:
  1. if (isset($_POST['title'])) {
  2. $this->title = $HTTP_POST_VARS['url'];

Görüldüğü gibi, $_POST['title'] oluşturulmuş mu diye bakıyor ama değer olarak $HTTP_POST_VARS['url']'yi atıyor. Ben bunu yukarıda "title" olarak düzelttim. Bilginize...

SINIFIN METODLARI

ping metodu

Belirtilmiş bir geri izleme adresine(URL) bir sinyal(ping) gönderir.

PLAIN TEXT
PHP:
  1. function ping($tb, $url, $title = "", $excerpt = "")
  2. {
  3. $response = "";
  4. $reason = "";
  5. // Varsayılan değerleri ata
  6. if (empty($title)) {
  7. $title = "Yazınız geri izlemeye alındı...";
  8. }
  9. if (empty($excerpt)) {
  10. $excerpt = "Yazınızı ilginç buldum, bundan dolayı bir geri izleme oluşturuyorum :)";
  11. }
  12. // Hedefi ayrıştır
  13. $target = parse_url($tb);
  14.  
  15. if ((isset($target["query"])) && ($target["query"] != "")) {
  16. $target["query"] = "?" . $target["query"];
  17. } else {
  18. $target["query"] = "";
  19. }
  20.  
  21. if ((isset($target["port"]) && !is_numeric($target["port"])) || (!isset($target["port"]))) {
  22. $target["port"] = 80;
  23. }
  24. // Soketi aç
  25. $tb_sock = fsockopen($target["host"], $target["port"]);
  26. // Birşeyler çözülemedi, döndür
  27. if (!is_resource($tb_sock)) {
  28. return '$trackback->ping: can\'t connect to: ' . $tb . '.';
  30. }
  31. // Göndermek istediklerimizi bir araya topla
  32. $tb_send = "url=" . rawurlencode($url) . "&title=" . rawurlencode($title) . "&blog_name=" . rawurlencode($this->blog_name) . "&excerpt=" . rawurlencode($excerpt);
  33. // Geri izlemeyi yolla
  34. fputs($tb_sock, "POST " . $target["path"] . $target["query"] . " HTTP/1.1\r\n");
  35. fputs($tb_sock, "Host: " . $target["host"] . "\r\n");
  36. fputs($tb_sock, "Content-type: application/x-www-form-urlencoded\r\n");
  37. fputs($tb_sock, "Content-length: " . strlen($tb_send) . "\r\n");
  38. fputs($tb_sock, "Connection: close\r\n\r\n");
  39. fputs($tb_sock, $tb_send);
  40. // Sonuçları al
  41. while (!feof($tb_sock)) {
  42. $response .= fgets($tb_sock, 128);
  43. }
  44. // Soketi kapa
  45. fclose($tb_sock);
  46. // Geri izleme sinyali çalıştı mı
  47. strpos($response, '<error>0</error>') ? $return = true : $return = false;
  48. // Sonucu gönder
  49. return $return;
  50. }

Fonksiyonumuz 4 adet string tipinde parametre alıyor:
$tb parametresi: geri izleme yapılacak adres
$url parametresi: bizim adresimiz
$title parametresi: geri izleme başlığı
$excerpt parametresi: geri izlemedeki alıntı yazısı

Fonksiyon başlangıçta, parametrelere değer atanıp atanmadığını göz önüne alarak varsayılan değerleri atıyor. Daha sonra girdiğimiz geri izleme adresini ayrıştırıyor. Ayrıştırma yaparken "query(sorgu)" denen, adresteki "?"den sonraki kısım eğer oluşturulmuş ve boş değilse, başına "?" ekleyerek kendine eşitliyor. Aksi durumda boş değer atıyor. Daha sonra "port" kısmını kontrol ediyor. Port kısmı oluşturulmuş ve numerik değilse, veya oluşturulmamışsa "80" değeri atanıyor.

Kontrol ve düzenlemeler bittikten sonra soket "host" ve "port" verileri sayesinde açılıyor. Eğer bağlanmada bir problem varsa, burada hata döndürülüyor. Hata yoksa; tüm göndermek istediğimiz veriler bir araya toplanıyor ve uygun formata çevrilip gönderiliyor. Önceki yazımızda bahsettiğimiz gibi sinyal gönderdikten sonra, bir de yanıt sinyali geliyordu. İşte biz verileri gönderdikten sonra, sıra geldi bize gelen yanıtı almaya...

Veriyi alıyoruz ve hata olup olmadığını kontrol ediyoruz. Geri izleme işlemimiz başarıyla tamamlandıysa "true (doğru)", tamamlanmadıysa "false (yanlış)" döndürüyoruz.

Fonksiyonun kullanılışını bir örnekle pekiştirmek gerekirse;

PLAIN TEXT
PHP:
  1. <?php
  2.  
  3. include('trackback_cls.php');
  4. $trackback = new Trackback('Shapcy.com', 'Mustafa ŞAPÇILI', 'UTF-8');
  5. if ($trackback->ping('http://www.shapcy.com/geri-izleme-trackback-nedir/trackback', 'http://www.shapcy.com/', 'Örnek Geri İzleme','"PHP Trackback - Bir “Geri İzleme” sınıfı" başlıklı yazıda geçen ping metodu ile yapılmış bir geri izleme örneği...')) {
  6. echo "Geri izleme başarıyla gönderildi...";
  7. } else {
  8. echo "Geri izleme gönderiminde hata var....";
  9. }
  10. ?>

Bu örneğin sonucunda "Geri İzleme (TrackBack) Nedir?" başlıklı yazımda şu geri izleme oluşturuldu.

recieve metodu

Geri İzlemeciler için tamam/hata mesajlarıyla birlikte XML yanıtları üretir.

PLAIN TEXT
PHP:
  1. function recieve($success = false, $err_response = "")
  2. {
  3. // Problemler olduğu takdirde kullanılacak varsayılan hata mesajları...
  4. if (!$success && empty($err_response)) {
  5. $err_response = "Geri izlemenizi kayıda almayı denerken bir problem oluştu...";
  6. }
  7. // Geri izlemeci için olan yanıtı başlat...
  8. $return = '<?xml version="1.0" encoding="' . $this->encoding . '"?>' . "\n";
  9. $return .= "<response> \n";
  10. // Cevabı geri gönder...
  11. if ($success) {
  12. // Geri izleme başarıyla alındı...
  13. $return .= "    <error>0</error> \n";
  14. } else {
  15. // Birşeyler ters gitti...
  16. $return .= "    <error>1</error> \n";
  17. $return .= "    <message>" . $this->xml_safe($err_response) . "</message>\n";
  18. }
  19. // Geri izlemeci için olan yanıtı bitir...
  20. $return .= "</response>";
  21.  
  22. return $return;
  23. }

Fonksiyonumuz 2 adet parametre alıyor:
$success parametresi: işlem başarısını saklayan değer (veri tipi: boolean)
$err_response parametresi: hata varsa bu hatayı açıklayan değer (veri tipi: string)

Fonksiyon başlangıçta, $success değeri "yanlış(false)" olarak ayarlanmışsa ve $err_response değeri boşsa varsayılan hata mesajını ayarlıyor. Daha sonra XML formatlı döndüreceğimiz yanıtımızı oluşturmaya başlıyor. $success değerine göre hata oluşup oluşmadığı da yanıtımıza dahil ediliyor ve bu değeri döndürüyor.

fetch metodu

Geri izleme bilgisini getirir ve bir RSS-0.91 beslemesi üretir.

PLAIN TEXT
PHP:
  1. function fetch($success = false, $response = "")
  2. {
  3. if (!$success && empty($response)) {
  4. $response = "Geri izleme bilgisi tekrar alınmaya çalışılırken bir hata oluştu...";
  5. }
  6. // Arayana yanıtı başlat
  7. $return = '<?xml version="1.0" encoding="' . $this->encoding . '"?>' . "\n";
  8. $return .= "<response> \n";
  9. // Yanıtı geri gönder...
  10. if ($success) {
  11. // Geri izleme başarıyla geri alındı...
  12. // Bir RSS (0.91) geri gönderiliyor -$response (array) değerinden geri izleme bilgisi...
  13. $return .= "    <error>0</error> \n";
  14. $return .= "    <rss version=\"0.91\"> \n";
  15. $return .= "    <channel> \n";
  16. $return .= "      <title>" . $this->xml_safe($response['title']) . "</title> \n";
  17. $return .= "      <link>" . $this->xml_safe($response['trackback']) . "</link> \n";
  18. $return .= "      <description>" . $this->xml_safe($response['expert']) . "</description> \n";
  19. $return .= "      <item> \n";
  20. $return .= "        <title>" . $this->xml_safe($response['title']) . "</title> \n";
  21. $return .= "        <link>" . $this->xml_safe($response['permalink']) . "</link> \n";
  22. $return .= "        <description>" . $this->xml_safe($response['expert']) . "</description> \n";
  23. $return .= "      </item> \n";
  24. $return .= "    </channel> \n";
  25. $return .= "    </rss> \n";
  26. } else {
  27. // Birşeyler ters gitti - $response (string) değerinden nedeni sağla...
  28. $return .= "    <error>1</error> \n";
  29. $return .= "    <message>" . $this->xml_safe($response) . "</message>\n";
  30. }
  31. // Geri izlemeci için olan yanıtı bitir
  32. $return .= "</response>";
  33.  
  34. return $return;
  35. }

Fonksiyonumuz 2 adet parametre alıyor:
$success parametresi: işlem başarısını saklayan değer (veri tipi: boolean)
$err_response parametresi: hata varsa bu hatayı açıklayan değer (veri tipi: string)

Fonksiyon başlangıçta, $success değeri "yanlış(false)" olarak ayarlanmışsa ve $response değeri boşsa varsayılan hata mesajını ayarlıyor. Daha sonra XML formatlı döndüreceğimiz yanıtımızı oluşturmaya başlıyor. $success değerine göre değişen yanıtımızı oluşturuyor ve bu değeri döndürüyor.

rdf_autodiscover metodu

Yazı hakkında RDF ile ifade edilmiş gömülü meta verisi üretir, Geri İzleme Sinyali Adresi'ni otomatik keşfeden istemcilere izin verir.

PLAIN TEXT
PHP:
  1. function rdf_autodiscover($RFC822_date, $title, $expert, $permalink, $trackback, $author = "")
  2. {
  3. if (!$author) {
  4. $author = $this->author;
  5. }
  6.  
  7. $return = "<!-- \n";
  8. $return .= "<rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\" \n";
  9. $return .= "    xmlns:dc=\"http://purl.org/dc/elements/1.1/\" \n";
  10. $return .= "    xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\"> \n";
  11. $return .= "<rdf:Description \n";
  12. $return .= "    rdf:about=\"" . $this->xml_safe($permalink) . "\" \n";
  13. $return .= "    dc:identifier=\"" . $this->xml_safe($permalink) . "\" \n";
  14. $return .= "    trackback:ping=\"" . $this->xml_safe($trackback) . "\" \n";
  15. $return .= "    dc:title=\"" . $this->xml_safe($title) . "\" \n";
  16. $return .= "    dc:subject=\"TrackBack\" \n";
  17. $return .= "    dc:description=\"" . $this->xml_safe($this->cut_short($expert)) . "\" \n";
  18. $return .= "    dc:creator=\"" . $this->xml_safe($author) . "\" \n";
  19. $return .= "    dc:date=\"" . $RFC822_date . "\" /> \n";
  20. $return .= "</rdf:RDF> \n";
  21. $return .= "-->  \n";
  22.  
  23. return $return;
  24. }

Fonksiyonumuz 6 adet parametre alıyor:
$RFC822_date parametresi: RFC822 formatındaki tarih bilgisi (veri tipi: string)
$title parametresi: başlık bilgisi (veri tipi: string)
$expert parametresi: alıntı değeri(veri tipi: string)
$permalink parametresi: adres değeri (veri tipi: string)
$trackback parametresi: geri izleme adresini saklayan değer (veri tipi: string)
$author parametresi: yazar bilgisi (veri tipi: string)

auto_discovery metodu

Yazıdaki bağlantıları ve bu bağlantılardaki geri izleme adreslerini arar.

PLAIN TEXT
PHP:
  1. function auto_discovery($text)
  2. {
  3. // Yazıdaki eşsiz bağlantıların bir listesini al
  4. // ---------------------------------------
  5. // (Değişimde 0=>link, 4=>host) için düzenli ifade
  6. $reg_exp = "/(http)+(s)?:(\\/\\/)((\\w|\\.)+)(\\/)?(\\S+)?/i";
  7. // Her bağlantının boşlukla bittiğine emin ol
  8. $text = eregi_replace("www.", "http://www.", $text);
  9. $text = eregi_replace("http://http://", "http://", $text);
  10. $text = eregi_replace("\"", " \"", $text);
  11. $text = eregi_replace("'", " '", $text);
  12. $text = eregi_replace(">", " >", $text);
  13. // Eşsiz bağlantılarla bir dizi oluştur
  14. $uri_array = array();
  15. if (preg_match_all($reg_exp, strip_tags($text, "<a>"), $array, PREG_PATTERN_ORDER)) {
  16. foreach($array[0] as $key => $link) {
  17. foreach((array(",", ".", ":", ";")) as $t_key => $t_value) {
  18. $link = trim($link, $t_value);
  19. }
  20. $uri_array[] = ($link);
  21. }
  22. $uri_array = array_unique($uri_array);
  23. }
  24. // Bu linklerden Geri izleme URI'larını al...
  25. // ------------------------------------------
  26. //  URI dizisi boyunca dön ve RDF parçalarını yapıştır
  27. $rdf_array = array(); // <-RDF parçalarının listesini tutan dizi
  28. foreach($uri_array as $key => $link) {
  29. if ($link_content = implode("", @file($link))) {
  30. preg_match_all('/(<rdf:RDF.*?<\/rdf:RDF>)/sm', $link_content, $link_rdf, PREG_SET_ORDER);
  31. for ($i = 0; $i < count($link_rdf); $i++) {
  32. if (preg_match('|dc:identifier="' . preg_quote($link) . '"|ms', $link_rdf[$i][1])) {
  33. $rdf_array[] = trim($link_rdf[$i][1]);
  34. }
  35. }
  36. }
  37. }
  38. // RDF dizisi boyunca dön ve geri izleme URI'larını yapıştır
  39. $tb_array = array(); // <- Geri izleme URI'ları listesini tutan dizi
  40. if (!empty($rdf_array)) {
  41. for ($i = 0; $i < count($rdf_array); $i++) {
  42. if (preg_match('/trackback:ping="([^"]+)"/', $rdf_array[$i], $array)) {
  43. $tb_array[] = trim($array[1]);
  44. }
  45. }
  46. }
  47. // Geri izlemeleri dön
  48. return $tb_array;
  49. }

Fonksiyonumuz 1 adet parametre alıyor:
$text parametresi: taranacak yazı (veri tipi: boolean)

Fonksiyon başlangıçta düzenli ifadeler ve belirlenmiş özel durumlara göre girilmiş parametreyi tarıyor ve eşsiz bağlantıların listesini bir dizide topluyor. Sonra bu dizideki liste taranıp RDF parçaları listesi oluşturuluyor. Bu işlemden sonra da bu RDF parçaları dizisi taranak geri izleme bağlantıları bulunuyor ve bu liste bir dizi olarak döndürülüyor.

YARDIMCI FONKSİYONLAR

Sınıfta, metodlar içinde kullanılan 3 adet yardımcı fonksiyon bulunuyor. Bunlar zaten basit işlemleri yerine getiren ufak fonksiyonlar. Bu yüzden detaylı anlatmayacağım, sadece ne işe yaradıklarını tek cümleyle belirtip kodları vereceğim.

RFC822_from_datetime

MySQL tarih-zaman değerini, standart RFC 822 tarih formatına dönüştürür.

PLAIN TEXT
PHP:
  1. function RFC822_from_datetime($datetime)
  2. {
  3. $timestamp = mktime(
  4. substr($datetime, 8, 2), substr($datetime, 10, 2), substr($datetime, 12, 2),
  5. substr($datetime, 4, 2), substr($datetime, 6, 2), substr($datetime, 0, 4)
  6. );
  7. return date("r", $timestamp);
  8. }

xml_safe

Bir dizgiyi, XML için güvenli bir dizgiye dönüştürür.(&, <, >, " ve ' karakterlerini değiştirir)

PLAIN TEXT
PHP:
  1. function xml_safe($string)
  2. {