09 Mar

Sphinx?in Ayarlanması ve Kullanımı

Önceki yazılarda sphinxin ne olduğunu açıklamaya çalışmıştım. Kısaca özet geçmek gerekirse, sphinx, bağımsız çalışan bir arama motorudur. Çok fazla veri içeren veritabanbları için , hızlı ve kolay, metin bazlı arama yapabilmek için kullanılabilecek bir uygulamadır.

Sphinxi paylaşımlı hostinglerde kullanabilmek pek mümkün olmaz sanırım. Çünkü sphinxi kullanabilmek için, sphinx sunucusu ve phpye has sphinx eklentisini kurmak gereklidir. Bunların haricinde, arama sunucusunun belirli aralıklarla çalışarak verileri yeniden indekslemesi gerekmektedir. Tüm bu ve buna benzer durumlardan ötürü, sphinxi sadece kendinizin yönetebildiği sunucularda kullanabileceğinizi unutmayın.

Şimdi gelelim sphinxin nasıl kullanılacağına. Bunun için sphinx ile birlikte gelen örnek veritabanını ve konfigürasyon dosyalarını kullanacağım.

Kurulumu tamamladıktan sonra, kurulum yaptığınız dizin altında bulunan etc kalsöründe (kendi bilgisayarımda sphinxi /opt/sphinx altına kurduğum için, /opt/sphinx/etc dizinini kullanacağım) bulunan example.sql dosyasını açarak başına kullanmak istediğimiz veritabanını ekleyelim:

CREATE DATABASE IF NOT EXISTS test;
use test;

Sonrasında :

1
mysql -u kullanici_adi -psifre<example.sql

komutunu çalıştırarak örnek veritabanını oluşturuyoruz. Bir sonraki adım ayar dosyasını oluştrumak. Yine aynı klasörde bulunan (/opt/sphinx/etc) sphinx.conf.dist sphinx-min.conf.dist dosyaları ile, tüm ayarları sıfırdan yapmak yerine. Varsayılan olarak gelen ayarları kullanıp veya düzenleyebiliriz. Varsayılan ayarlar her zaman işimize yaramaz, ama kendisi ile gelen örnek veritabanı ile uyumlu. Çok fazla karmaşaya sebep olmamak için en basit ve kısa olan ayarını kullanacağım :

1
sudo cp sphinx-min.conf.dist sphinx-test.conf

Yukarıdaki komutu çalıştırdığımızda, birlikte gelen ayar dosyalarından, sphinxin çalışabilmesi için gerekli olan minimum ayarların bulunduğu dosyayı, kendi ihtiyaçlarımız için düzenleyebileceğimiz ayrı bir dosya olarak kaydettim. sphinx-test.conf dosyasının içeriği aşağıdaki gibidir: (sphinx verisyonuna göre değişiklik gösterebilir)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#
# Minimal Sphinx configuration sample (clean, simple, functional)
#

source src1
{
   type        = mysql

   sql_host    = localhost
   sql_user    = test
   sql_pass    =
   sql_db         = test
   sql_port    = 3306   # optional, default is 3306

   sql_query      = \
      SELECT id, group_id, UNIX_TIMESTAMP(date_added) AS date_added, title, content \
      FROM documents

   sql_attr_uint     = group_id
   sql_attr_timestamp   = date_added

   sql_query_info    = SELECT * FROM documents WHERE id=$id
}


index test1
{
   source         = src1
   path        = /opt/sphinx/var/data/test1
   docinfo        = extern
   charset_type      = sbcs
}


index testrt
{
   type        = rt
   rt_mem_limit      = 32M

   path        = /opt/sphinx/var/data/testrt
   charset_type      = utf-8

   rt_field    = title
   rt_field    = content
   rt_attr_uint      = gid
}


indexer
{
   mem_limit      = 32M
}


searchd
{
   listen         = 9312
   listen         = 9306:mysql41
   log         = /opt/sphinx/var/log/searchd.log
   query_log      = /opt/sphinx/var/log/query.log
   read_timeout      = 5
   max_children      = 30
   pid_file    = /opt/sphinx/var/log/searchd.pid
   max_matches    = 1000
   seamless_rotate      = 1
   preopen_indexes      = 0
   unlink_old     = 1
   workers        = threads # for RT to work
}

Sphinxi hızlıca ayarlayabilmek için yapmanız gereken, bir source, bir index ve searchd ayarının tanımlı olması gerekiyor.

source : Arama yapılmasını istediğnizi veritabanına ve tabloya yapılacak bağlantı ve sorgunun tanımlaması burada yapılır. Sphinx bu ayar yardımı ile , veritabanına bağlanır, ilgili tabloadan verileri çeker ve indexler. Böylece sphinxe bir arama sorgusu gönderdiğinizde size sonuç döndürebilir. Burada veritabanına bağlanmak için gerekli parametrelerin nasıl verilmesi gerektiğini açıklamama grek yok sanırım. Ayar anahtarları gayet açıklayıcı duruyor. Ayar dosyası içeirisinde birden fazla source tanımlanabilir.

Burda üstünde duracağım ayar anahtarı “sql_query”. Buraya, indekslenmesini istediğiniz verileri elde edebileceğiniz sorguyu yazmalısınız. Sphinxin size dayattığı en belirgin kural, bu sql sorgusunun en az bir “id” alanı içermesidir. Bunun haricinde SQLinizi istediğiniz gibi yazabilirsiniz.

Sphinx ayar dosyasında mutlaka dikkat etmeniz gereken bir diğer husus ise, yeni bir satıra geçmek istiyorsanız satır bitimine \ karakteri eklemeniz gerektiğidir. Eğer buna dikkat etmezseniz sphinx ayar dosyasını ayrıştırıken hata verecek ve çalışmayı durduracaktır.

sql_attr_ ile başlayan ayar anahtarı, aramanız üzerinde filtreleme yapabilmeniz için kullanabileceğiniz alanları tanımlamanızı sağlar. Bu tanımlamalar, sorgu yaptığınız tablo üzerindeki alanlardan biri olmalıdır. sql_attr_ den sonra, ilgili alanın tipini belirtmelisiniz ( örneğin sql_attr_timestamp = date_added , sorgu yaptığınız tablo üzerinde timestamp tipinde date_added alanını temsil eder). Daha fazla ayrıntı için sphinx dökümantasyonunda “Data source configuration options” başlığına bakınız.

sql_query_info yu es geçebilirsiniz.

index : Bu başlıkta , sphinxin verileri nasıl indekslemesi gerektiği belirtilir. Ayar dosyası içerisinde birden faxla index başlığı olabilir ve bu index başlıklarını kod tarafında arama yaparken seçebilir ve istediğiniz indeks üzerinde arama yaptırabilirsiniz. Ayar dosyasında mutlaka bir index olmak zorundadır. index bir source a sahip olmalıdır. “index test1” başlığı altında tanımlanmış örnekte görüldüğü gibi , bir source tanımlanmış, index verilerilerinin nerede saklanması gerektiği belirtlimiş (path= /opt/sphinx/var/data/test1). docinfo ve charset_type ı es geçiyorum, bunlarla ilgili daha fazla bilgiyi sphinx dökümantasyonunda bulabilirsiniz. Basit bir ayar için belirttiğim iki anahtar yeterlidir. searchd de bulunan ayarları değiştirmenize gerek yok şimdilik.

Yukarıdaki ayar dosyasında gerekli ayarları yaptıktan sonra, sphinxin gerekli dataları oluşturmasını sağlamaktır. Bunun için:

1
sudo /opt/sphinx/bin/indexer --all --config /opt/sphinx/etc/sphinx-test.conf

Yukarıdaki kod ile, ayar dosyamızdaki direktiflere göre veriler indexlenecek. Eğer bir problem olmaz ise, aşağıdaki gibi bir çıktı alırsınız :

1
2
3
4
5
6
7
8
9
10
11
12
13
Sphinx 1.11-dev (r2709)
Copyright (c) 2001-2011, Andrew Aksyonoff
Copyright (c) 2008-2011, Sphinx Technologies Inc (http://sphinxsearch.com)

using config file '/opt/sphinx/etc/sphinx-test.conf'...
indexing index 'test1'...
collected 4 docs, 0.0 MB
sorted 0.0 Mhits, 100.0% done
total 4 docs, 193 bytes
total 0.036 sec, 5290 bytes/sec, 109.64 docs/sec
skipping non-plain index 'testrt'...
total 3 reads, 0.000 sec, 0.1 kb/call avg, 0.0 msec/call avg
total 9 writes, 0.000 sec, 0.1 kb/call avg, 0.0 msec/call avg

Örnek veritabanında çok fazla veri olmadığı için indeksleme işlemi çok kısa sürede tamamlandı. Şimdi sıra geldi arama sunucusunu çalıştırmaya :

1
sudo /opt/sphinx/bin/searchd --config /opt/sphinx/etc/sphinx-test.conf

Bunu çalıştırdığınızda aşağıdakine benzer bir sonuç alırsınız :

1
2
3
4
5
6
7
8
9
10
Sphinx 1.11-dev (r2709)
Copyright (c) 2001-2011, Andrew Aksyonoff
Copyright (c) 2008-2011, Sphinx Technologies Inc (http://sphinxsearch.com)

using config file '/opt/sphinx/etc/sphinx-test.conf'...
listening on all interfaces, port=9312
listening on all interfaces, port=9306
precaching index 'test1'
precaching index 'testrt'                                  
precached 2 indexes in 0.001 sec

Yukarıda çalıştırmış olduğumuz kod, arama sunucumuzun çalışmasını sağlar, böylece bizde arama sunucusuna sorgu göndererek arama işlemini gerçekleştirebiliriz.

Sphinx sunucumuzu ayarlayıp çalıştırmış olduk. Burda bahsettiğim /opt/sphinx klasörü kendi bilgisayarıma özgü bir yoldur. Siz nereye kurulum yaptı iseniz o dizini referans alınız.

Şimdi sphinxi ayarladık ve çalıştırdık, bitti mi ? Tam olarak bitti denemez, veritabanınıza sürekli veri ekleneceği için sphinx indekslerinin yenilenmesi gerekir. Bunun için de belirli aralıklarla :

1
/opt/sphinx/bin/indexer --all --rotate --config /opt/sphinx/etc/sphinx-test.conf

bu kodun çalışması gerekmektedir. Bu kod, indekslerin yenilenmesini sağlar. Bunu bir cron job olarak çalıştırabilirsiniz. Bu işlemin sıklığı ihtiyaçlarınıza göre değişir. Günde bir defa da yaptırabilirsiniz, dakikada bir de yaptırabilirsiniz. Bu tamamen size kalmış ( veritabanın büyüklüğü de rol oynuyor tabiki). Eğer yeniden indeksleme yapmazsanız, yeni girilen kayıtlar arama sonuçlarında çıkmaz.

Sunucunuzu ayarlayıp çalıştırdıktan sonra, buradaki örnekte olduğu gibi arama işlemi yapabilirsiniz.

Sphinx, çok fazla ayrıntıya sahip olan bir arama motoru sunucusudur. Burda aktarmaya çalıştıklarımdan daha fazlasını sphinx dökümantasyonunda bulabilirsiniz. Gayet anlaşılabilir bir dil ile örnekleyerek anlatmakta.

Bu seriye ait diğer yazılar :

Metin Bazlı Arama – Site İçi Arama Motoru
Aramanın Yapılması – Site İçi Arama Motoru
Sphinx nedir ?
Sphinx Kurulumu
Sphinx?in Ayarlanması ve Kullanımı

09 Feb

Sphinx nedir ?

MySQL 5.0 sürümünden itibaren güzel bir özellik sundu : fulltext search. Bu özellik sayesinde, veritabanındaki bir tablonun,istenilen alanları (fulltext indeksi eklenmiş alanlar) üzerinde metin bazlı arama yapabiliyoruz.

Fulltext search sadece MyISAM tipindeki tablolar üzerinde çalışabilmekte. Ayrıca çok da performanslı olduğu söylenemez.

Performans haricinde arama sırasında da çok da esnek olmayan bir yapısı var.

İşte burada Search Engine Server ( Arama motoru sunucusu) devreye giriyor.

Bu arama motrolarının yaptığı şey, veritabanından bağımsız çalışarak, verilerin, veritabanından belirli aralıklarda çekilerek indekslenmesi. Sonrasında da kendine gelen arama sorguları esnasında, indekslenmiş kayıtlar içerisinden sonucu kısa sürede vermek.

MySQL Fulltext Search de süreç şu şekilde olur:

Fulltext indeksi eklenmiş tablodaki alan üzerinde sorgu çalıştırılır :
SELECT * FROM articles
-> WHERE MATCH (title,body) AGAINST (‘database’);
Çıkan sonuçlar direkt olarak kullanılır.

Arama motoru sunucusundaki süreç de şöyle işler :

– Arama motoruna bağlatı yapılır
– Aranan kelime iletilir
– Aranan kelimenin bulunduğu kayıtların ID lerinin bulunduğu sonuçlar geri döndrülür
– Arama motoru sonuçları (eğer sonuç döndüyse) ayıklanarak veritabanından ilgili kayıtlar ID lerine göre çekilir.

Arama motoru ile ilgili işlem adımları daha çok görünse de,mysql fulltext search den daha hızlı sonuç alabilmekteyiz.

Burda bilinmesi gereken bir şey daha var, arama motoru sunucsu belirli aralıklarla veritabanına bağlanarak verileri yeniden indekslemek zorundadır. Yani üzerinde arama yapılan tabloya yeni veriler girilmiş veya mevcut veriler değişitirilmiş ya da silinmiş olabilir. İşte bu yüzden bir cron job ile , arama motorunun yeniden indeksleme yapması sağlanmalıdır. Bu indeksleme ve yeniden indeksleme ile ilgili konuya bir sonraki yazıda değinmeye çalışacağım.

Konumuzun başlığını oluşturan “Sphinx nedir” in cevabı: Yukarıda değinildiği gibi, veritabanından bağımsız olarak çalışarak, veritabanından çektiği verileri indeksleyen, sonrasında arama sorgularına cevap veren bir arama motoru sunucusudur. Sphinxin indeksleme yapabilmesi için tablo yapısının (MyISAM, InnodDB vb) önemi yoktur. Ayrıca dökümantasyonunda yazdıklarına göre, sadece MySQL için değil, PostgreSQL için de desteği mevcut..

Bu seriye ait diğer yazılar :

Metin Bazlı Arama ? Site İçi Arama Motoru
Aramanın Yapılması ? Site İçi Arama Motoru
Sphinx nedir ?
Sphinx Kurulumu
Sphinx’in Ayarlanması ve Kullanımı

28 Jan

REST Nedir ?

REST, ingilizce Representational State Transfer ( Temsili Durum Transferi) kelimelerinin kısaltması (REST) dır. Temelde, HTTP protokolü ile çalışan, dağıtık hypermedia sistemleri için kullanılan bir yazılım mimarisi biçimidir. REST de SOAP gibi bir servisdir.

SOAP da olduğu gibi , bir sunucu ve bir istemci tarafı vardır. Yalnız SOAP dakinin aksine, bellli bir standardı yoktur. Tek ortak yanları ve standartları HTTP dir. Her ikisi de HTTP protokolü üzerinden haberleşir.

Standartdan kastım, SOAP haberleşirken WSDL denen XML’leri kullanır. Sunucu da istemci de bu XML’lere göre çalışır. Sunucu, WSDL standardına göre oluşturulmuş XML i okuyarak, hangi sorgulara cevap vereceğini, ne sonuçlar döndüreceğini bilir. İstemci ise, bu xml yardımı ile, nereye bağlanacağını, hangi çağrıları yapacağını ve ne sonuçlar alacağını bilir. Böylece bu yazılı kurallar çerçevesinde sunucu ve yazıcı arasında iletişim gerçekleşir.

REST de ise, böyle XML veya benzeri, iletişimi bir standart içerisinde sınırlandıran veya belirleyen bir yapı yok. Sadece şöyle bir standart mevcut : İstemci , sunucuya isteklerini HTTP protokolü üzerinden GET, POST,PUT veya DELETE kullanarak istek yapmalıdır.

REST in SOAP, XML-RPC vb servislerin yerine tercih edilmesinin en önemli sebebi, REST’in birçok platformda, ekstra kütüphaneye ihtiyaç duymadan çalışabilmesidir. Ayrıca diğer birçok servis mimarisine göre daha kolay kullanılabilir, öğrenilebilir ve uygulanabilirdir. Bu ve daha birçok avantajınun dışında en önemli dezavantajı bir standardı olmayışıdır. Her bir REST sunucusu ile iletişim kurmak için farklı yöntemler kullanmanız gerekebilir.
Aynı zamanda bu sunucu tarafında da aynı, REST sunucusunun yazılması tamamen geliştiriciye kalmış.

REST i daha iyi anlatabilmek için küçük bir REST sunucusu ve REST istemcisi yazdım. Yalnız dikkat etmeniz gereken şey, aşağıda yazdığım kodlar, bir ürün içerisinde kullanılmaya uygun olmadığıdır. REST tarafında güvenlik tamamen geliştiriciye kaldığı için, REST sunucunuzu tasarlarken güvenlik işlemlerini ayrıca ve titizlikle yapmalısınız. Aksi taktirde istemediğiniz sonuçlar ile karşılaşma olasılığınız yüksektir.

Burdaki kodların çalışabilmesi için linux bir makinaya sahip olmanız gerekiyor. Windows kullanmadığım için , windows makina üzerindeki kurulumun nasıl yapılacağını anlatmayacağım.

1- Kendi makinanızda bulunan web sunucusunda restex diye bir klasör oluşturun. Ben kendi makinamda /var/www dizini altına oluşturdum. Ve geri kalan ayarları da bu dizin yapısını baz alarak anlatacağım

2- /etc/hosts dosyasını sudo komutu ile açarak şu satırı ekleyin :
127.0.0.1 api.local

3- Apache’de bir sanal host tanımlayın. Bendeki Apache ayarlarının bulunduğu dizin /etc/apache2/sites-enabled/000-default olduğundan, ben bu dosyaya aşağıdaki satırları ekledim

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<VirtualHost *:80>
        ServerAdmin webmaster@localhost

        DocumentRoot /var/www/restex
        ServerName api.local
        <Directory />
                Options FollowSymLinks
                AllowOverride All
        </Directory>
        <Directory /var/www/restex/>
                Options Indexes FollowSymLinks MultiViews
                AllowOverride All
                Order allow,deny
                allow from all
        </Directory>
</VirtualHost>

Tabi bunu yapabilmek için sudo ile super user hakları ile açmış olduğum bir editörle yapabileceğimi de vurgulayayım. Gerçi düzenli linux kullanıcıları buna alışkındır, fakat yeni başlayanlar bunu unutur çoğunlukla.

4- Apache’yi yeniden başlattım :

1
sudo apache2ctl restart

5- /var/www/restex dizini içerisinde bir .htaccess dosyası oluşturdum ve içine şunları ekledim :

1
2
3
4
5
6
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]

Bu satırları eklememdeki amaç, api.local hostuna gelecek tüm çağrıları index.php ye yönlendirmem gerektiğindendir. Böylece api çağrımın ne olduğunu bulabileceğim ( aşağıda ekledğim sunucu kodundaki -RestServer- response metodunu inceleyerek bu işlemi neden yaptığımı daha iyi kavrayabilirsiniz )

6- /var/ww/restex dizini altında index.php oluşturarak şu satırları ekledim (sunucu kodu) :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?php
class RestServer {
  /**
   * Döndürülecek yanıt tipini belirliyoruz
   *
   * @var string $responseType
   */

  protected $responseType;
  /**
   * Classımızın construct metoduna döndürmek istediğimiz
   * farklı bir yanıt tipi varsa bunu verebiliyoruz
   *
   */

  public function __construct($responseType = "text/json"){
    $this->responseType = $responseType;
  }
  /**
   * Sunucumuzun başlatılmasını sağlar
   *
   * @return void
   */

  public function run(){
    // döndürmek istediğimiz yanıt tipini belirtiyoruz.
    header('Content-type: '.$this->responseType);
    // yaptığımız hataları başkaları görsün istemiyoruz :)
    set_error_handler(array($this,'errorHandler'));
    // gelen komutu algılayıp cevabımızı ekrana yazdırıyoruz
    echo $this->response();
  }
  /**
   * Tüm işi burası yapıyor, bizden ne istendiğini
   * anlayarak bir cevap vermemiz gerekiyor.
   *
   * @return mixed
   */
 
  public function response(){
    $request   = substr($_SERVER['REQUEST_URI'],1);
    $request   = explode('/',$request);
    $function  = array_shift($request);

    if(isset($_POST['params'])) {
      $_POST['params'] = json_decode($_POST['params']);
      return call_user_func_array($function,$_POST['params']);
    }else {
      return call_user_func($function);
    }
  }
  /**
   * Hata yakalayıcımız, sistemdeki hataları göstermeyip standart
   * bir mesaj döndürüyoruz. Bu sistemi geliştirerek hata raporlaması vb şeyler de
   * yapılabilir. Fantaziye gerek yok, basit bir örnek sadece :)
   */

  public function errorHandler ($errno, $errstr, $errfile, $errline) {
    echo 'Hatalı veya eksik istek';
    exit;
  }
}
$server = new RestServer('text/html');
$server->run();

Sunucu kodunu açıklama grek yok sanırım, kod üzerindeki açıklamalar yardımcı olacaktır.

7- Şimdi sıra geldi sondan bir önceki adıma. REST istemcimi oluşturmak için , web ana dizininde rest.client.php oluşturdum ( /var/www/rest.client.php) ve içerisine aşağıdaki satırları ekledim :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<?php

class RestClient {
  /**
   * Api çağrıların yapmamızı sağlayacak istemcimiz
   * REST çağrıları HTTP protokolü ile yapılacağından
   * curl e ihityaç duyuyoruz
   *
   * @var resource
   */

  protected $client;
  /**
   * Api çağrılarının yapılacağı URL
   *
   * @var string
   */

  protected $url;

  public function __construct($url){
    $this->client = curl_init();
    $this->url = $url;
    curl_setopt($this->client, CURLOPT_RETURNTRANSFER ,1);
  }
  /**
   * Rest sunucumuza istek yapmamızı ve sonucu
   * ekrana yazdırmamızı sağlar.
   *
   * @return void
   */

  public function call($function,$params=null){
    curl_setopt($this->client,CURLOPT_URL,$this->url.'/'.$function);
     curl_setopt($this->client, CURLOPT_POST, 0);
    if(is_array($params)){
      curl_setopt($this->client, CURLOPT_POST, 1);
      curl_setopt($this->client,CURLOPT_POSTFIELDS,$params);
    }
    echo curl_exec($this->client);
  }
}

$client = new RestClient('api.local');
$client->call('date',array('params'=>json_encode(array('d-m-Y H:i:s'))));
$client->call('phpinfo');

8- Ve geldik son adıma, tarayıcıdan localhost/rest.client.php çağırıyoruz. Eğer eksiksiz yaptı iseniz bu adımları, ekranınıza tarih ve php bilgisi dökülmeli. RestClient kodunu da açıklamaya gerek yok sanırım.

Görüldüğü gibi, REST adı ile korkutucu ve karmaşık görünmesine rağmen. Çok da zor olmayan bir yapıya sahip. Yukarıda yaptığımız örnekte sunucumuza istek olarak, php fonksiyonlarını gönderdik. Sunucumuzda kendinde bu php kodlarını çalıştırdı ve bize sonucu döndürdü.
Normal şartlarda sunucu böyle bodoslama her çağrıyı yerine getirmez. Twitter veya Flickr gibi sosyal medya sitelerinin API lerini incelerseniz, Rest sunucusu için kullanılabilecek güvenlik sisteminin nasıl olması gerektiğini kafanızda daha iyi oturtabilirsiniz.

22 Jan

Sphinx Kurulumu

Sphinx kurulumu için aşağıdaki adımları takip etmek gerekiyor. Öncelikle adımları yazıyorum, sonra bunları açıklamaya çalışacağım :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
mkdir sphinx-base
cd sphinx-base
wget http://pecl.php.net/get/sphinx -o /dev/null -O  sphinx.tar.gz
svn checkout http://sphinxsearch.googlecode.com/svn/trunk
cd trunk/api/libsphinxclient/
./configure --prefix=/usr/local
make
make install
cd ~/sphinx-base
tar -zxvf sphinx.tar.gz
cd sphinx-1.1.0/
phpize
/configure --prefix=/usr/local --with-sphinx
make
make install
nano /etc/php5/conf.d/sphinx.ini
extension=sphinx.so
cd ~/sphinx-base/trunk
configure --prefix=/usr/local
make
make install

(1-2) İndirdiğimiz dosyaların derli toplu olabilmesi için bir dizin oluşturdum, bu dizini home klasörümde oluşturdum. Siz de aynı şekilde home dizininizde sphinx-base diye bir klasör oluşturursanız , burdaki örneğin çalışabilmesi mümkün olur. Klasörü oluşturduktan sonra klasöre giriyoruz

(3-4) PHP sphinx eklentisini, sonrasında da sphinx kodlarını sitelerinden indiriyoruz

(5-6-7-8) PHP eklentimizin çalışabilmesi için, libsphinxclient kütüphanesine ihityaç var. Bu yüzden öncelikle bunu derliyoruz.

(9-10-11-12-13-14-15-16-17) Bu uzun adımlarda da php eklentisini derliyoruz.

(18-19-20-21) Bu adımlarda da sphinxi derliyoruz.

Yuakrıdaki adımlarda mutlaka dikkat etmeniz gereken şeyler var. Bunlardan ilki, yukarıda belirttiğim gibi home klasörünüzde sphinx-base diye bir klasör
oluştrumuş olmanız gerekli.
Anlattığım tarih ititbari ile, php sitesinden indirdiğim (3) dosyayı indirememiş olabilirsiniz. Dosyanın doğru yolunu bularak sphinx-base klasöürne indirin ve yukarıda belirttiğim şekilde (10) sphinx-base klasörü içerisine açın. İndirdiğim versiyondaki klasör ismi sphinx-1.1.0 . Sizin edindiğiniz dosyanın ismi farklı olabilir, bu yüzden 11. adımda doğru klasöre giriş yapmalısınız.

Sisteminizde, derlemeler için gerekli kütüphaneler mevcutsa, kurulumu sorunsuz olarak tamamlanacaktır. Bir sonraki yazıda, sphinx ile gelen örnek veritabanı ve örnek ayarlar ile basit bir örnek kod ekleyeceğim.

Bu seriye ait diğer yazılar :

Metin Bazlı Arama ? Site İçi Arama Motoru
Aramanın Yapılması ? Site İçi Arama Motoru
Sphinx nedir ?
Sphinx Kurulumu
Sphinx’in Ayarlanması ve Kullanımı

22 Jan

Aramanın Yapılması – Site İçi Arama Motoru

1
2
3
4
5
6
7
8
$sphinx = new SphinxClient;
$sphinx->setServer('localhost',9312);
$sphinx->setMatchMode(SPH_MATCH_EXTENDED);
$sphinx->setMaxQueryTime(30);
$sphinx->setLimits(1,6);  
echo '<pre>',
          print_r($sphinx->query($arananKelime,"indexAdi"),true),
          '</pre>';

Sphinx ile yapılan aramalar direkt veritabanı tabloları üzerinde olmamaktadır, Sphinx kurulumunda belirttiğimiz index üzerinde bir SQL oluştururuz. Bu SQL, Sphinx in indeksleyeceği verileri veritabanından almasını sağlar, bu verileri bizim belirleyeceğiniz aralıklarda alarak indeksi günceller.

Arama işlemini yapmak için yukarıdaki kodlar çalıştırılmalıdır. Kodlar sade ve anlaşılır.
Sınıfımızı oluşturuyor,sunucu adresimizi ve portunu ayarlıyoruz (genelde yukarıda belirtilen portta çalışır, siz farklı bir port belirtmedikçe). Sonrasında arama modu, toplam sorgu zamanı ve limit değerlerini ayarladıktan sonra sorgumuzu çalıştırıyoruz.

Bu sorgu sonucunda aşağıdakine benzer bir sonuç elde edersiniz (eğer aramanızdan sonuç dönmezse null döner) :

Array
(
    [error] => 
    [warning] => 
    [status] => 0
    [fields] => Array
        (
            [0] => name
            [1] => short_description
            [2] => description
            [3] => meta_description
        )

    [attrs] => Array
        (
            [type_id] => 1
            [language] => 1
        )

    [matches] => Array
        (
            [507] => Array
                (
                    [weight] => 1
                    [attrs] => Array
                        (
                            [type_id] => 1
                            [language] => 1
                        )

                )

            [508] => Array
                (
                    [weight] => 1
                    [attrs] => Array
                        (
                            [type_id] => 12
                            [language] => 1
                        )

                )

            [509] => Array
                (
                    [weight] => 1
                    [attrs] => Array
                        (
                            [type_id] => 1
                            [language] => 1
                        )

                )

            [510] => Array
                (
                    [weight] => 1
                    [attrs] => Array
                        (
                            [type_id] => 1
                            [language] => 1
                        )

                )

            [511] => Array
                (
                    [weight] => 1
                    [attrs] => Array
                        (
                            [type_id] => 12
                            [language] => 1
                        )

                )

            [512] => Array
                (
                    [weight] => 1
                    [attrs] => Array
                        (
                            [type_id] => 1
                            [language] => 4
                        )

                )

        )

    [total] => 1000
    [total_found] => 28214
    [time] => 0
)

Yukarıda dönen sonucu açıklayayım :
error, warning, status, fields, attrs alanlarını açıkalamaya gerek yok şimdilik, çünkü adlarından anlaşıldığı gibi, sorgu ile ilgili gerekli bazı bilgilerin döndürülmesini sağlar.
Burda en önemli anahtar matches dır. Bu anahtar altında, aranan kelimeye uygun kayıtların ID’leri döndürülür.

 [511] => Array
                (
                    [weight] => 1
                    [attrs] => Array
                        (
                            [type_id] => 12
                            [language] => 1
                        )

                )

Burdaki kaydın anlatmaya çalıştığı şey şudur : aradığınız kelime 511 nolu kayıtda mevcut ve bu kaydın attributleri şunlardır, bu kelimenin arama ağırlığı şudur vb. Burdaki attrs, index oluşturulması sırasında bizim tarafımızdan belirlenir. Eğer herhangi bir attribute belirtmezsek buradaki attrs anahtarı altında hiçbir kayıt olmayacaktır.
Attribute tanımlamanın temel amacı, aranan kelimeyi filtereleyebilmektir.

Bunların dışında kalan total kısmı, bir defada listelenebilecek veri miktarını.
Total found, arama sonucu bulunan toplam kayıt miktarını temsil eder.

Daha önce belirttiğimiz gibi, sorgu direkt olarak veritabanı üzerindeki tablo üzerinde çalıştırılmaz, arama motoru sunucusu verileri aldıktan sonra bağımsız olarak çalışarak, bu verileri en hızlı sonuç verecek şekilde indeksler. Sonra siz sorgu yaptığınızda, belirtmiş olduğunuz tabloda, aradığınız metne uyan kayıdın ID sini ve yaptığınız ayarlamaya göre diğer sonuçları döndürür (yukarıdaki örnek sonuç gibi).

Sonrasında yapmanız gereken, dönen SPhinx sonuçlarından IDleri ayıklayarak veritabanı üzerindeki tabloya sorgu yapmak :

$sorgu='SELECT*FROM books where id in(507,508,509,510,511,512)';

Burda vermiş olduğum örnek döküm, bilgisayarımda çalışan Sphinx sunucusunda oluşturduğum indexde yapılan arama sonucu dönen veridir. Sizin oluşturacağınız indexlerde yapacağınız aramalarda, yukarıdakine benzer sonuç alamayabilirsiniz. Ama ana bölümler aynıdır.

Bu seriye ait diğer yazılar :

Metin Bazlı Arama ? Site İçi Arama Motoru
Aramanın Yapılması ? Site İçi Arama Motoru
Sphinx nedir ?
Sphinx Kurulumu
Sphinx’in Ayarlanması ve Kullanımı

22 Jan

Metin Bazlı Arama – Site İçi Arama Motoru

Aslında burda anlatmaya çalışacağım şey, bir site içi arama motorunun nasıl oluşturulcağından öte, bu iş için kullanılabilecek, metin bazlı bir arama motorunu (Sphinx) anlatmak.

Basit anlamda bir site içi arama motoru, site içerisine eklenmiş bütün metinleri arayabilecek bir SQL sorgusu ile yapılır. Bunun için basit SQL ler veya daha iyi sonuç alabilmek için kompleks SQL lerde kullanılabilir.

Ama ne yazık ki, başarılı bir metin bazlı arama için bunlar yetmiyor. Arama yapacak tablo veya tabloların boyutu arttıkça sorgularımızın yavaş çalışması kaçınılmaz olacak. İşte burda devreye metin bazlı arama motorları devreye giriyor.

Bu arama motorları, kullanılan veritabanlarından bağımsız olarak çalışarak, istenilen tablo veya tablolardan metinlerin alınıp indekslenmesi ile, daha hızlı ve daha başarılı arama sonuçları alınmasını sağlıyor.

Açık kaynak kodlu ve ücretsiz bazı arama motorları şunlar :

DataparkSearch
Ferret
Ht-//Dig
Hyper Estraier
Lemur/Indri
Lucene
mnoGoSearch
Sphinx
Swish-e
Xapian

Bunlardan sadece Sphinx ve Lucene’i inceleme fırsatı bulabildim. Lucene in dağıtık sistemler için uygun olmaması ve (benim için) anlaşılması zor bir yapısı olması sebebi ile Sphinx ile çalışmalarıma devam ettim. Sphinx iyi bir dökümantasyona sahip, kolayca kurup ayarlama yapabiliyorsunuz.

Normalde öncelikle kurulumundan başlayarak anlatmam gerekirdi, ama bu sefer tersinden anlatmaya çalışacağım :

– Aramanın yapılması
– İstemcinin kurulması
– Sunucunun kurulması ve yapılandırılması

şeklinde anlatmaya çalışacağım.

Sphinxin PHP için hazırlanmış bir eklentisi mevcut, eklenti kurmak istemiyorsanız, Sphinx işlemlerini yapabilmek için hazırlanmış hazır bir sınıf da mevcut. Ben eklentiyi kullanmayı tercih ediyorum, ama eklentinin kurulmasının mümkün olmadığı zamanlarda bu sınıf iyi bir çözüm olabilir.

Burda eklentiyi baz alarak anlatacağım, bu yüzden burda yazdığım kodlar ile API classını kullanırken hata alırsanız, bunun API classından kaynaklanabileceğini unutmayın. Böyle bir ihtimal düşük olmakla birlikte belirtmekte fayda var.

Bu seriye ait diğer yazılar :
Metin Bazlı Arama ? Site İçi Arama Motoru
Aramanın Yapılması ? Site İçi Arama Motoru
Sphinx nedir ?
Sphinx Kurulumu
Sphinx’in Ayarlanması ve Kullanımı

16 Aug

Var Olan Bir Web Servisi Kullanmak

Daha önceki konularda , genel olarak WSDL yapısını anlatmaya çalıştım. WSDL’i nasıl kullanacağımıza dair bir örnek de verdim. Gene WSDL kullanımına dair bir örnek vereceğim, yalnız bu sefer biz sadece istemci tarafı olacağız.

Mevcut bir web servis ile iletişim kurmamız gerekiyor, bize WSDL adresi verildi, gerekli dökümanın da verildiğini varsayarak örneğimize geçelim.

Örneğimizdeki WSDL , kendisine verilen alan adının kime ait olduğunu söylemekte. Yani basit bir WHOIS sorgusu yapan bir web servis. Bu web servis, WebserviceX.Net adlı bir site tarafından Asp.Net kullanılarak hazırlanmış ( http://www.webservicex.net/whois.asmx?wsdl ). Biz de WSDL aracılığı ile Asp.Net de yazılmış bu servisi kullanacağız.

Tabi öncelikle WSDL i eclipse aracılığı ile açıyoruz, böylece hangi metodların olduğunu ve ne gibi parametreler aldığını, ne sonuç döndüreceğiniz görebileceğiz.

wsdl örnek

Yukarıdaki kalabalık kafanızı karıştırmasın. Bize gerekli olan alan, renkli olarak işaretlenmiş alan. Burada GetWhoIs adında bir metodun olduğunu ve cevap olarak GetWhoIsResponse tipinde bir veri dönderdiğini görüyoruz.

GetWhoIs metodu parametre olarak GetWhoIs tipinde bir veri almakta. Aşağıda, WSDL için gerekli sınınıfı oluşturdum :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
class GetWhoIS {
   public $HostName;
   public function __construct($host){
      $this->HostName=$host;
   }
}

$parametre = new GetWhoIS('ersindogan.com');
$istemci=new SoapClient('http://www.webservicex.net/whois.asmx?wsdl',array('trace'=>1));
try {    
$sonuc = $istemci->GetWhoIS($parametre);
echo '<xmp><pre>',print_r($sonuc,true),'</pre></xmp>';
}catch(Exception $e){
echo $e->getMessage();
}

Görüldüğü gibi, öyle karmaşık işlemler yapmadan, birkaç adımda, kolayca, web servisimizi kullanabilir biçimde kodumuzu oluşturabiliyoruz. Uğraşmamız greken herhangi bir XML kodu yok,web servisin hangi dil ile oluşturulmuş olduğunun önemi yok, sanki kendi oluşturduğumuz bir classmış gibi kolaylıkla kullanabiliyoruz.

Bu örnekte metod adı (GetWhoIs) ile aldığı parametrenin adı aynı, bu kafanızı karıştırmasın. Yukarıdaki oluşturduğum class , web servisde bulunan metodun aldığı parametredir.

Güzel günler dileği ile.

16 Aug

Eclipse ile WSDL Oluşturma

Web servis ile uğraşırken, en çok sıkıntı yaratan şey WSDL oluşturmak sanırım. En yalın hali ile XML den ibaret bir dosya olmasına rağmen , çok fazla ayrıntı olması bu işi zorlaştırıyor.

Ama,WSDL dosyasını HTML gibi , gerekli etiketleri kullanarak, bir yazı editörü ile oluşturabilmek de mümkün. Biz kolay yöntemi kullanarak , Eclipse yardımı ile WSDL dosyasını oluşturacağız.

Eclipse ile WSDL dosyasını oluşturabilmek için, yeni bir proje açarak veya var olan proje içerisinde
File -> New -> Other adımlarını takip ettiğimizde, karşımıza çıkan pencerede bulunan Web Services başlığı altındaki, WSDL File seçip “Next”e tıklayarak bir diğer adıma geçin.

Bu adımda WSDL dosyamıza bir ad vererek bir diğer adıma geçin.

Bu adımda bulunan “Target namespace” yazan alana, benzersiz bir url yazın (örnek için var olan kayıdı değiştirmeseniz de olur)

“Prefix” alanına da herhangi birşey yazabilirsiniz , örneğin “tns” yerine “orn” yazabilirsiniz.
Buradaki “Create WSDL skeleton” seçeneğinde bulunan işareti kaldırın, çünkü bize örnek bir WSDL oluşturmasını istemiyoruz, kendimiz sıfırdan oluşturacağız.

Bu işlemden sonra “Finish”e tıkladığımızda, bir kaç satır koddan oluşan bir sayfa gelir karşımıza. Bu sayfa “Source” ve “Design” olmak üzere iki bölüm vardır. Biz “Design” bölümünü kullanacağız, burası görsel olarak WSDL’i oluşturabileceğimiz bölümdür.

WSDL oluşturmaya geçmeden önce, web servisimizin ne olacağını ve ne görev yapacağını belirlemeliyiz. Böylece WSDL’imizi de bu yapılacak işlere göre oluşturacağız.

Web servisimiz bir stok servisi olsun, urun stok durumunu kontrol edebilen ve stoğu listeleyebilen , ürünün stok durumunu gösterebilen bir servisimiz olsun. Bu web servisde kullanılacak sınıfımız da aşağıdaki gibi olsun :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class StokYanit {
   public $mesaj;
   public $kod;
   public function __construct($mesaj,$kod){
      $this->mesaj=$mesaj;
      $this->kod=$kod;
   }
}
class Urun {
   public $id;
   public $ad;
   public $renk;
   
   public function __construct($id,$ad,$renk){
      $this->id=$id;
      $this->ad=$ad;
      $this->renk=$renk;
   }
}

class Stok {
   public function liste(){}
   public function kontrolEt(Urun $urun){
      return new StokYanit($urun->ad.' ürünüden x adet kalmıştır',100);
   }
}

Yukarıdaki kod sadece sistemin işleyişini anlatabilmek için oluşturuldu. Şimdi geçelim bu stok servisimizin WSDL’ini oluşturmaya.
Az önce bahsettiğim gibi , “Design” bölümünü kullanacağız. Design bölümüne tıkladığımızda karşımıza boş bir sayfa çıkacaktır. Bu sayfada bir alana sağ tıklayalım :

– Add Service
– Add Binding
– Add PortType

ve daha birkaç seçeneğin de olduğu bir menü çıkar. Bu menüden bu üç seçeneği yazdım, çünkü en çok kullanacağımız seçenekler bunlar.

Şimdi , yukarıdaki Class’ın WSDL’imizde karşılığını oluşturacağız. Böylece web servisimizi kullanarak sistemimizde stok işlemeleri yapılabilecek.

Add PortType bir port ekler, burada servisin yapısını oluşturmamızı sağlar (Bizim örneğimizde IStok, bu adlandırmayı rastgele yaptım) .

Add Service ile bir servis oluşturulur, servis çağrısının yapılacağı konumu belirtmemizi sağlar (endpointURI burada tanımlanır)

Add Binging ile de Service ve PortType arasında bağ kurulması sağlayan “Binding” nesnesi oluşturulur.

Burda en önemli ve en karmaşık olan bölüm “Add PortType”. Çünkü bu seçenek ile servisimizin yapısını oluştururuz.

Buraya kadar anlattıklarımı video olarak aşağıda bulabilirsiniz. Tek tek resim ekleyerek anlatmak uzun ve zor olacağından böyle bir yöntem seçtim. Yalnız ses problemini aşamadığım için videoda ses yok.

Videoyu izlemeye geçmeden önce yukarıda bulunan kodlardaki “Class”lara iyi bakın, çünkü WSDL de bu yapıyı kuracağız.

Eclipse ile WSDL oluşturma from Ersin DOĞAN on Vimeo.

Konu ile ilgili daha fazla bilgi vermek gerek, yalnız ayrıntı fazla olduğu için , konuyu dağıtmadan nasıl tamamlayabileceğimi bilemediğim için, yazıyı burada kesiyorum. Aklınıza takılan şeyleri burda yorum olarak yazarsanız, konun devamını yorumlardan sürdürebiliriz.

Güzel günler dileği ile.

08 Aug

Web servislerinde hata ayıklama

“looks like we got no XML document” hatasını aldığımızda , öylesine kalakalırız ilk başlarda. Çünkü web servisin çalışması için gerekli kodları yazmış ve gerekli ayarlamaları yapmıştık. Neden çalışmıyor ki bu meret, yok mu bunun neden çalışmadığını anlamanın yolu. Var tabiki.

Gönderilen her SOAP çağrısını (SOAP Request) ve cevabını (SOAP Response) izleyebiliriz. Bunun için yapmamız gereken yaptığımız çağrıyı try catch bloğu içerisine yazarak, hata olduğu zaman dönen cevabı yazdırmak.

Daha önceki yazıda verdiğim örnekten yola çıkarak anlatmaya çalışayım.

Sunucu tarafını burda vermeyeceğim, çünkü daha önceki yazıda mevcut. Şimdi istemci tarafındaki kodu yazalım :

1
2
3
4
5
6
7
8
9
10
11
$istemci=new SoapClient(null,
                  array('uri'=>'http://ersindogan-testuri',
                 'location'=>'http://localhost/test/sunucu.php',
                  'trace'=>1));
try {
var_dump($istemci->gonder('mesaj','konu','kime'));
}catch(Exception $e){
 echo '<xmp><pre>',
        print_r($istemci->__getLastResponse(),true),
        '</pre></xmp>';
}

Eski örneğe eklediğimiz iki farklı şey var :
Biri try-catch blogu içeirisine yazdık kodlarımızı.
İkinci olarak, hata olduğunda dönen cevabı yazdırarak sorunun nerde olduğunu anlamaya çalışıyoruz. Ayrıca unutmadan söyleyeyim, SOAP isteğinden dönen cevabı görebilmek için , SOAPClient nesnemizin kurucusuna parametre olarak “trace” anahtarını vererek, bunun açık olmasını sağlamalıyız. Aksi taktirde dönen cevabı ekrana bastırmaya kalktığımızda hiçbirşey göremeyiz.
Aynı durum “xmp” etiketi için de geçerli, eğer cevabımızı bu etiketler arasında yazdırmazsak , gene aynı biçimde dönen cevabı ekrana basmaya kalktığımızda hiçbirşey göremeyiz. “xmp” etiketi, w3c tarafından kullanımı önerilmeyen, kodları etkisizleştirerek salt metin biçiminde gösterilmesini sağlayan bir html etiketi. Her nekadar kullanılmaması önerilse de, bu tip hata ayıklama işlemlerinde çok yardımcı oluyor.

Web servisler üzerine birşeyler yazarken, hata ayıklamayı yazmayı unutmuşum. Bana gelen bir epostadan sonra , bu konu üzerinde birşeyler yazmak istedim. Umarım açıklayıcı yazabilmişimdir.

Güzel günler dileği ile…

04 Jul

Eposta adresi doğrulama

Genellikle eposta doğrulamak için kullanılan yöntem , bir düzenli ifade ile verile adresi doğrulamaktır :

1
2
3
if(!preg_match('/^[^@]+@[a-zA-Z0-9._-]+\.[a-zA-Z]+$/', $email)) {
  echo  'geçersiz eposta';
}

Ama , bu sadece eposta adresinin belirli standartta yazılmasını sağlar, boyle@biradresyok.com yazdığınızda yukarıdaki kontrolü devredışı bırakır. Siz epostanın doğru olduğunu kabul edersiniz.

Eposta doğrulamanın bir başka yolu daha var . Verilen eposta adresine ait mx kaydının olup olmadığını kontrol etmek :

1
2
3
4
5
6
7
8
9
10
11
12
$email='boyle@biradresyok.com';

$sunucu= substr($email,strpos($email,'@')+1);

$sonuc= array();
getmxrr($sunucu,$sonuc);

if(count($sonuc)>0){
 echo 'adres gecerli';
}else {
 echo 'adres gecersiz';
}

Bu yöntemin bir dezavantajı, mx kaydını kontrol ederken, mx kaydı olmayan bir adres olduğu zaman bir süre bekletmesidir (birkaç saniye). Bunun haricinde mx kaydı kontrol ederek eposta doğrulaması , diğer yöntemlere göre çok daha yüsek doğruluk payı olan sonuçlar verebilir.