3. dleplugin.xml Referansı

dleplugin.xml (ya da ZIP kökündeki herhangi bir *.xml dosyası), eklentinizin kimlik kartı ve kurulum talimatıdır. Dosya adı serbesttir — önemli olan ZIP'in kökünde bulunması ve içeriğinin doğru şemada olmasıdır.

İskelet

Eksiksiz ama boş bir manifest şöyle görünür:

<?xml version="1.0" encoding="utf-8"?>
<dleplugin>
    <name>Eklentimin Adı</name>
    <description>Kısa açıklama</description>
    <icon>engine/data/emoticons/plugin.png</icon>
    <version>1.0</version>
    <dleversion>21.0</dleversion>
    <versioncompare>greater</versioncompare>

    <!-- Veritabanı blokları -->
    <mysqlinstall><![CDATA[ ]]></mysqlinstall>
    <mysqlupgrade><![CDATA[ ]]></mysqlupgrade>
    <mysqlenable><![CDATA[ ]]></mysqlenable>
    <mysqldisable><![CDATA[ ]]></mysqldisable>
    <mysqldelete><![CDATA[ ]]></mysqldelete>

    <!-- PHP blokları (içine <?php YAZILMAZ) -->
    <phpinstall><![CDATA[ ]]></phpinstall>
    <phpupgrade><![CDATA[ ]]></phpupgrade>
    <phpenable><![CDATA[ ]]></phpenable>
    <phpdisable><![CDATA[ ]]></phpdisable>
    <phpdelete><![CDATA[ ]]></phpdelete>

    <!-- Dosya yamaları -->
    <file name="engine/modules/main.php">
        <operation action="after">
            <searchcode><![CDATA[aranacak_satır]]></searchcode>
            <replacecode><![CDATA[eklenecek_kod]]></replacecode>
            <searchcount>1</searchcount>
            <enabled>1</enabled>
        </operation>
    </file>
</dleplugin>

Üst düzey etiketler

Sürüm kapısı: dleversion + versioncompare

versioncompare yalnızca şu değerleri kabul eder; başka bir değer yazarsanız boş sayılır ve kapı devre dışı kalır:

needplugin — eklentiler arası bağımlılık

Başka bir eklentiye ihtiyaç duyuyorsanız adını yazın. Birden fazlası virgülle ayrılır:

<needplugin>diger-eklenti,bir-baskasi</needplugin>

Kurulum anında bu eklentilerden herhangi biri yoksa, sizinki active = 0 olarak kurulur. Ayrıca needplugin işaretli eklentiler, yamalar uygulanırken ikinci sıraya alınır — yani bağımlı olduğunuz eklenti önce yamalanır.

filedelete ve dosya silme

<filedelete>1</filedelete> demek, "eklenti silinince yüklediğim dosyaları da sil" demektir. Ancak bu koşulludur:

• Silinecek dosya listesi, yalnızca ZIP ile kurulumda otomatik doldurulur. Manifesti kopyala-yapıştır yöntemiyle kurduysanız liste boştur ve hiçbir şey silinmez.
• DLE, silme sırasında çekirdek dosyalarını korur; listede olsa bile bu dosyalar silinmez.

Veritabanı blokları

Beş blok vardır ve her biri farklı bir anda çalışır:

Kullanılabilir yer tutucular

Bu bloklar str_ireplace ile işlenir; yani yer tutucular büyük/küçük harf duyarsızdır. Kullanabileceğiniz dört yer tutucu:

Örnek bir kurulum bloğu:

<mysqlinstall><![CDATA[
CREATE TABLE IF NOT EXISTS `{prefix}_benim_tablom` (
  `id`     INT(11)      NOT NULL AUTO_INCREMENT,
  `baslik` VARCHAR(255) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE={engine} DEFAULT CHARSET={charset};

DELETE FROM `{prefix}_admin_sections` WHERE `name` = 'benim-eklentim';
INSERT INTO `{prefix}_admin_sections`
  (`name`, `title`, `descr`, `icon`, `allow_groups`)
VALUES ('benim-eklentim', 'Benim Eklentim', 'Ayarlar', 'reaction.png', '1');
]]></mysqlinstall>

PHP blokları

Beş PHP bloğu, SQL bloklarıyla birebir aynı zamanlarda çalışır (phpinstall, phpupgrade, phpenable, phpdisable, phpdelete).

<phpinstall><![CDATA[
// Örnek: şablon etiketini otomatik ekle
$dosya = ROOT_DIR . '/templates/' . $config['skin'] . '/main.tpl';
if (is_file($dosya)) {
    $ic = file_get_contents($dosya);
    if (strpos($ic, '{benim_kutum}') === false) {
        file_put_contents($dosya, str_replace('{content}', "{content}\n{benim_kutum}", $ic));
    }
}
]]></phpinstall>

Dosya yamaları: file ve operation

Yapı iki katmanlıdır: bir <file> altında birden fazla <operation> bulunabilir.

<file name="engine/modules/main.php">
    <operation action="before">
        <searchcode><![CDATA[ilk çapa]]></searchcode>
        <replacecode><![CDATA[bu üstüne eklenecek]]></replacecode>
        <searchcount>1</searchcount>
        <enabled>1</enabled>
    </operation>
    <operation action="after">
        <searchcode><![CDATA[ikinci çapa]]></searchcode>
        <replacecode><![CDATA[bu altına eklenecek]]></replacecode>
        <enabled>1</enabled>
    </operation>
</file>

operation alt etiketleri

action türleri — tam davranış

Çapa birden fazla geçiyorsa

searchcount vermezseniz DLE, çapayı bulduğu her yerde yamayı uygular. Örneğin echo gibi kısa bir çapayı seçip searchcount'u boş bırakırsanız kodunuz dosyaya onlarca kez eklenir. Bu yüzden:

• Çapayı mümkün olduğunca uzun ve benzersiz seçin,
• Yine de <searchcount>1</searchcount> yazın.

Doğrulama kuralları — sessizce atlananlar

DLE manifesti okurken bazı işlemleri hata vermeden atlar. Bu, hata ayıklamayı zorlaştıran en büyük tuzaktır. Bilmeniz gerekenler:

Güvenlik ve sınırlar

• Yama yalnızca .php ve .lng dosyalarına uygulanır.
• Şu dosyalar korumalıdır ve yamalanamaz: engine/classes/mysql.php, engine/classes/plugins.class.php, engine/data/config.php, engine/data/dbconfig.php, engine/data/socialconfig.php, engine/data/videoconfig.php.
• Sunucuda PLUGINS_READ_ONLY tanımlıysa eklenti kurma/düzenleme/silme tamamen engellenir.
• Panelden yapılan tüm eklenti işlemleri hem user_hash hem referer denetiminden geçer.

Sıradaki ve en zor konu: doğru çapa seçmek. Çapa Sanatı.