projektboerse.php

<?php
/*
 * Plugin Name: TH Köln Projektbörsen-Klient
 * Description: Projekte erstellen und mit der TH-Köln Projekt- und Themenbörse synchronisieren.
 * Author: Andreas Paulick
 * Author URI: https://github.com/andreaspaulick
 * Version: 0.2
 * Plugin URI: https://github.com/andreaspaulick/projektboerse
*/

defined( 'ABSPATH' ) or exit;
define( 'DEFAULT_API_URL' , 'http://localhost:8045/' ); // default link to the PB API
define( 'DEFAULT_KEYCLOAK_API_URL' , 'http://localhost:8180/auth/realms/pboerse/protocol/openid-connect/token' ); // default link to the keycloak API
define( 'USE_LOCAL_PB' , TRUE ); // here you can choose whether to use the local "pb dummy" or the official test version of the PB via internet

include 'pb_options.php';

/**
 * post Variable Reference: https://codex.wordpress.org/Function_Reference/$post
 */
function post_published_api_call( $ID, $post) {

    if( get_post_meta($post->ID, '_pb_wporg_meta_key0', true) !== "1" ) return; // return (do nothing) if checkbox "also send to pb" is not checked

        // TODO alter URL
        if(USE_LOCAL_PB === FALSE) {
            $url = rtrim(get_option('pb_api_url', array('pb_api_url' => DEFAULT_API_URL))['pb_url'], '/') . '/projects'; // add json-consuming ressource to url. Strip last slash if present
        }
        else {
            $url = rtrim(get_option('pb_api_url', array('pb_api_url' => DEFAULT_API_URL))['pb_url'], '/') . '/posts/jsonadd'; // add json-consuming ressource to url. Strip last slash if present
        }

        $title = $post->post_title;
        $content = wp_strip_all_tags($post->post_content); // at the moment all tags are stripped (images won't be transferred)

        // data for local DUMMY PROJEKTBÖRSE
        if(USE_LOCAL_PB === TRUE) {
            $post_data = array(
                'status' => get_post_meta($post->ID, '_pb_wporg_meta_project_status', true),
                'title' => $title,
                'content' => $content,
                'course' => implode(",", get_post_meta($post->ID, '_pb_wporg_meta_key1', true)),
                'type' => implode(",", get_post_meta($post->ID, '_pb_wporg_meta_project_type', true)),
                'user_login' => wp_get_current_user()->user_login
            );
        }
        else {
            // data for Testserver Projektbörse --> https://gptest.archi-lab.io/projects
            $post_data = array(
                'status' => 'GEPLANT',
                'name' => $title,
                'description' => $content
            );
        }

        $json_post = json_encode($post_data);

        // save the project-id of the pb-post (if set)
        $pb_project_id = get_post_meta($post->ID, 'pb_project_id', true);

        if( metadata_exists( 'post', $post->ID, 'pb_project_id' )){ // means the project is edited

            // TODO: change URL to PB
            $url2 = rtrim(get_option('pb_api_url', array('pb_api_url' => DEFAULT_API_URL))['pb_url'], '/').'/posts/id/'.$pb_project_id ;

            if(get_option('token_enable_checkbox')['token_enable']==="0") { // if true: don't use keycloak-authentication
                $data = wp_remote_request($url2, array(
                    'headers' => array( 'Content-Type' => 'application/json; charset=utf-8'),
                    'body' => $json_post,
                    'method' => 'PUT'
                ));
            }
            else { // use keycloak-authentication
                $token_response = get_keycloak_token_response();
                $keycloak_access_token = extract_keycloak_access_token($token_response);

                if ($keycloak_access_token === "TOKEN_REQUEST_ERROR"){
                    return;
                }

                $data = wp_remote_request($url2, array(
                    'headers' => array( 'Content-Type' => 'application/json; charset=utf-8',
                        'Authorization' => 'Bearer ' . $keycloak_access_token),
                    'body' => json_encode( array(
                            'id' => $pb_project_id,
                            'status' => get_post_meta($post->ID, '_pb_wporg_meta_project_status', true),
                            'title' => $title,
                            'content' => $content,
                            'course' => implode(",", get_post_meta($post->ID, '_pb_wporg_meta_key1', true)),
                            'type' => implode(",", get_post_meta($post->ID, '_pb_wporg_meta_project_type', true)),
                            'user_login' => wp_get_current_user()->user_login
                    )),
                    'method' => 'PUT'
                ));

                //logout session
                keycloak_session_logout($token_response);
            }
        }
        else { // no previously saved project-id = new project
            if(get_option('token_enable_checkbox')['token_enable']==="0") { // if true: don't use keycloak-authentication

                $data = wp_remote_post($url, array(
                    'headers' => array( 'Content-Type' => 'application/json; charset=utf-8'),
                    'body' => $json_post,
                    'method' => 'POST'
                ));
            }
            else { // use keycloak-authentication
                $token_response = get_keycloak_token_response();
                $keycloak_access_token = extract_keycloak_access_token($token_response);

                if ($keycloak_access_token === "TOKEN_REQUEST_ERROR"){
                    return;
                }

                $data = wp_remote_post($url, array(
                    'headers' => array( 'Content-Type' => 'application/json; charset=utf-8',
                        'Authorization' => 'Bearer ' . $keycloak_access_token),
                    'body' => $json_post,
                    'method' => 'POST'
                ));
                // save the id of the pb-project
                update_post_meta( $post->ID, 'pb_project_id', json_decode(wp_remote_retrieve_body($data))->id);
                //logout session
                keycloak_session_logout($token_response);
            }

        }
}
add_action( 'publish_projects', 'post_published_api_call', 10, 2);


// not only delete projects in wordpress, but also delete the corresponding entry in the pb via REST API
function pb_sync_delete_post($postid){
    global $post_type;
    $pb_project_id = get_post_meta($postid, 'pb_project_id', true);

    //TODO alter URL
    $url = rtrim(get_option('pb_api_url', array('pb_api_url' => DEFAULT_API_URL))['pb_url'], '/').'/posts/delete/'.$pb_project_id ;

    if(get_option('token_enable_checkbox')['token_enable']==="0") { // don't use keycloak auth
        if(get_option('pb_sync_delete')['pb_sync_delete_field']==="1" && $post_type == 'projects'){

            $response = wp_remote_request($url, array('method' => 'DELETE' ));
        }
    }
    else { // use keycloak auth
        if(get_option('pb_sync_delete')['pb_sync_delete_field']==="1" && $post_type == 'projects'){

            $token_response = get_keycloak_token_response();
            $keycloak_access_token = extract_keycloak_access_token($token_response);

            if ($keycloak_access_token === "TOKEN_REQUEST_ERROR"){
                return;
            }

            $response = wp_remote_request($url, array(
                'headers' => array( 'Authorization' => 'Bearer ' . $keycloak_access_token),
                'method' => 'DELETE'
            ));

            //logout session
            keycloak_session_logout($token_response);
        }
    }
}
add_action('before_delete_post', 'pb_sync_delete_post');

// custom post-type "projects":
function wpt_project_post_type() {
    $labels = array(
        'name'               => __( 'Projekte' ),
        'singular_name'      => __( 'Projekt' ),
        'add_new'            => __( 'Projekt erstellen' ),
        'add_new_item'       => __( 'Neues Projekt anlegen' ),
        'edit_item'          => __( 'Projekt bearbeiten' ),
        'new_item'           => __( 'Neues Projekt anlegen' ),
        'view_item'          => __( 'Projekt anzeigen' ),
        'view_items'         => __( 'Projekte anzeigen' ),
        'all_items'          => __( 'Alle Projekte' ),
        'search_items'       => __( 'Projekte suchen' ),
        'not_found'          => __( 'Keine Projekte gefunden' ),
        'not_found_in_trash' => __( 'Keine Projekte im Papierkorb gefunden' )
    );
    $supports = array(
        'title',
        'editor',
    );
    $args = array(
        'labels'               => $labels,
        'supports'             => $supports,
        'public'               => true,
        'capability_type'      => 'post',
        'rewrite'              => array( 'slug' => 'projects' ),
        'has_archive'          => true,
        'menu_position'        => 30,
        'menu_icon'            => 'dashicons-welcome-learn-more',
        'register_meta_box_cb' => 'pb_wporg_add_custom_box',
    );
    register_post_type( 'projects', $args );
}
add_action( 'init', 'wpt_project_post_type');


// add a [sc_pb_meta] shortcode at the end of every project-type-post
add_filter('the_content', 'modify_content');
function modify_content($content) {
    global $post;
    if($post->post_type === 'projects')
        return $content . "[sc_pb_meta]" ;
    else
        return $content;
}

// add type-tags (PP, BA, MA) to the title
add_filter('the_title', 'modify_title', 10, 2);
function modify_title($title, $id) {
    global $post;
    $types = get_post_meta($id, '_pb_wporg_meta_project_type', true);
    $add_title = (isset(get_option('pb_add_type_tag')['pb_add_type_tag_field']) && "1" === get_option('pb_add_type_tag')['pb_add_type_tag_field']) ? 1 : 0;

    if (!empty($types) && $post->post_type === 'projects' && $add_title === 1)
        return "[".implode("/",$types)."] ".$title;
    else
        return $title;
}


function sc_pb_meta_function(){
    global $post;

    $study_courses = get_post_meta($post->ID, '_pb_wporg_meta_key1', true); // get array of selected courses
    $project_type = get_post_meta($post->ID, '_pb_wporg_meta_project_type', true);

    if(!empty($project_type)){
        foreach ($project_type as &$type) {
            if ($type === 'PP') $type = 'Praxisprojekt';
            elseif ($type === 'BA') $type = 'Bachelorarbeit';
            elseif ($type === 'MA') $type = 'Masterarbeit';
        }
    }
    else
        $project_type = ["nicht spezifiziert"];

    $project_status = get_post_meta($post->ID, '_pb_wporg_meta_project_status', true);

    if ($project_status === 'available') $project_status = 'verfügbar';
    elseif ($project_status === 'in_progress') $project_status = 'in Bearbeitung';
    elseif ($project_status === 'done') $project_status = 'abgeschlossen';

    $all_courses = get_pb_courses(); // get array of all courses
    $out_courses = array(); // target array for human-readable study course names

    // translate long course-id into human readable course-name:
    if (!empty($study_courses)) {
        foreach ($study_courses as $key => $value) {
            array_push($out_courses, $all_courses[$value]);
        }
    }
    else
        array_push($out_courses, "nicht spezifiziert");


    return "
            <span style=\"font-size: 12px;\">             
            <strong>Projektstatus:</strong><br />".$project_status."<br /><br />     
            <strong>Geeignete Studiengänge:</strong><br />".implode("<br />", $out_courses)."<br /><br />
            <strong>Geeignet für:</strong><br />".implode("<br />", $project_type).
            "</span>";

}
add_shortcode('sc_pb_meta', 'sc_pb_meta_function');

// Add custom metabox paragraph for THK projects on "post" and "wporg_cpt" pages
function pb_wporg_add_custom_box()
{
    //$screens = ['post', 'wporg_cpt'];
    //foreach ($screens as $screen) {
        add_meta_box(
            'studiengang_wporg_box_id',           // Unique ID
            'Projektattribute',  // Box title
            'pb_custom_box_html',  // Content callback, must be of type callable
            'projects'                  // Post type
        );
    //}
}
add_action('add_meta_boxes', 'pb_wporg_add_custom_box');

// HTML input fields for post metadata. Loads the last saved data!
function pb_custom_box_html($post)
{
    $meta = get_post_meta( $post->ID );

    if(!isset( $meta['_pb_wporg_meta_key0'][0])){  // if meta-key is unset it means that we are about to create a new post
        $checkbox_value = (isset(get_option('pb_send_to_pb')['pb_send_to_pb_field'])) ? 1 : 0;  // set default value for checkbox depending on user settings
    }
    else { // user is editing an existing project and we saved a value ("1" or "0") for the checkbox before
        $checkbox_value = ('1' === $meta['_pb_wporg_meta_key0'][0] ) ? 1 : 0;
    }

    $study_course = get_post_meta($post->ID, '_pb_wporg_meta_key1', true);
    $project_type = get_post_meta($post->ID, '_pb_wporg_meta_project_type', true);
    $project_status = get_post_meta($post->ID, '_pb_wporg_meta_project_status', true);
    ?>
    <p>
        <label><input type="checkbox" name="checkbox_value" value="1" <?php checked( $checkbox_value, 1 ); ?> />Mit TH-Köln Projektbörse synchronisieren?</label>
    </p>
    <hr>
    <p>
        <label for="pb_wporg_project_status"><strong>Projektstatus:</strong><br /></label>
        <select name="pb_wporg_project_status" id="pb_wporg_project_status" class="postbox">
            <option value="available" <?php selected( $project_status, "available" ); ?>>verfügbar</option>
            <option value="in_progress" <?php selected( $project_status, "in_progress" ); ?>>in Bearbeitung</option>
            <option value="done" <?php selected( $project_status, "done" ); ?>>abgeschlossen</option>
        </select>
    </p>
    <p>
        <label for="pb_wporg_course"><strong>Studiengang:</strong><br /></label>
        <select name="pb_wporg_course[]" id="pb_wporg_course" class="postbox" multiple="multiple" size="6">
            <?php
                $data = get_pb_courses();  // get all the courses via REST-API
                foreach($data as $key => $item){
            ?>
                <option value="<?php echo $key;?>" <?php echo ( !empty( $study_course ) && in_array( $key, $study_course ) ? ' selected="selected"' : '' ) ?>><?php echo $item; ?></option>
            <?php
                }
            ?>
        </select>
    </p>
    <p>
        <label for="pb_wporg_project_type"><strong>Projekt geeignet für:</strong><br /></label>
        <input type="checkbox" name="pb_wporg_project_type[]" id="pb_wporg_project_type_pp" value="PP" <?php echo ( !isset( $meta['_pb_wporg_meta_project_type'][0]) || !empty( $project_type ) && in_array( 'PP', $project_type ) ? ' checked' : '' ) ?>>
        <label for="pb_wporg_project_type_pp">Praxisprojekt<br /></label>

        <input type="checkbox" name="pb_wporg_project_type[]" id="pb_wporg_project_type_ba" value="BA" <?php echo ( !isset( $meta['_pb_wporg_meta_project_type'][0]) || !empty( $project_type ) && in_array( 'BA', $project_type ) ? ' checked' : '' ) ?>>
        <label for="pb_wporg_project_type_ba">Bachelorarbeit<br /></label>

        <input type="checkbox" name="pb_wporg_project_type[]" id="pb_wporg_project_type_ma" value="MA" <?php echo ( !isset( $meta['_pb_wporg_meta_project_type'][0]) || !empty( $project_type ) && in_array( 'MA', $project_type ) ? ' checked' : '' ) ?>>
        <label for="pb_wporg_project_type_ma">Masterarbeit<br /></label>
    </p>
    <?php
}

// save the pb-metabox data into a unique meta key
function pb_wporg_save_postdata($post_id)
{
    // checkbox
    $checkbox_value = ( isset( $_POST['checkbox_value'] ) && '1' === $_POST['checkbox_value'] ) ? 1 : 0; // Input var okay.
    update_post_meta( $post_id, '_pb_wporg_meta_key0', esc_attr( $checkbox_value ) );

    // study course
    if (array_key_exists('pb_wporg_course', $_POST)) {

        update_post_meta(
            $post_id,
            '_pb_wporg_meta_key1',
            //implode(', ', $_POST['pb_wporg_course']) // array to single string
            $_POST['pb_wporg_course']
        );
    }

    // project type
    if (array_key_exists('pb_wporg_project_type', $_POST)) {
        update_post_meta(
            $post_id,
            '_pb_wporg_meta_project_type',
            $_POST['pb_wporg_project_type']
        );
    }

    // project status
    if (array_key_exists('pb_wporg_project_status', $_POST)) {
        update_post_meta(
            $post_id,
            '_pb_wporg_meta_project_status',
            $_POST['pb_wporg_project_status']
        );
    }

}
add_action('publish_projects', 'pb_wporg_save_postdata', 9);


function wp_post_to_html($wp_post_content){
    $remove_tags = str_replace("<!-- /wp:paragraph -->","", str_replace("<!-- wp:paragraph -->","", $wp_post_content));
    $replace_line_breaks = str_replace("\n","", str_replace("\n\n", "<br />", $remove_tags));
    $remove_p = str_replace("</p>","", str_replace("<p>", "", $replace_line_breaks));
    return $remove_p;
}

function extract_keycloak_access_token($response){

    if($response==="TOKEN_REQUEST_ERROR" || !is_array($response) && strpos($response, 'cURL error 7:') !== false)
        return "TOKEN_REQUEST_ERROR";

    $kc_response = json_decode($response['body']); // JSON to array

    return $kc_response->access_token; // get access-token
}

function get_keycloak_token_response(){

    $kc_url = get_option('token_api_url', array('token_url' => DEFAULT_KEYCLOAK_API_URL))['token_url'];
    $kc_clientid = get_option('token_api_clientid')['token_clientid'];
    $kc_username = get_option('token_api_username')['token_username'];
    $kc_password = get_option('token_api_password')['token_password'];

    // if URL does not start with 'http' return error message
    if(strpos($kc_url,"http" )===false)
        return "URL_MALFORMED";

    $request_body = array(
        'client_id' => $kc_clientid,
        'username' => $kc_username,
        'password' => $kc_password,
        'grant_type' => 'password'
    );

    $response = wp_remote_post($kc_url, array(
        'headers' => array( 'Content-Type' => 'application/x-www-form-urlencoded'),
        'body' => http_build_query($request_body),
        'method' => 'POST'
    ));

    if ( is_wp_error( $response ) ) {
        $error_message = $response->get_error_message();
        return $error_message;
    }
    else if($response['response']['code']!==200)
        return "TOKEN_REQUEST_ERROR";

    return $response;
}

function keycloak_session_logout($keycloak_token_response) {

    if($keycloak_token_response==="TOKEN_REQUEST_ERROR")
        return $keycloak_token_response;

    $kc_clientid = get_option('token_api_clientid')['token_clientid'];
    $refresh_token = json_decode($keycloak_token_response['body'])->refresh_token;  // get refresh-token

    $url = preg_replace("/\btoken$/","logout", get_option('token_api_url', array('token_url' => DEFAULT_KEYCLOAK_API_URL))['token_url']);  // replace "token" endpoint with "logout" endpoint from Token-URL

    $data = wp_remote_post($url, array(
        'headers' => array( 'Content-Type' => 'application/x-www-form-urlencoded'),
        'body' => http_build_query(array(
            'client_id' => $kc_clientid,
            'refresh_token' => $refresh_token)),
        'method' => 'POST'
    ));
}

// retrieves pretty study-course-list from PB REST API
function get_pb_courses() {

    // TODO remove hardcoded URL before release:
    //$url = rtrim(get_option('pb_api_url', array('pb_api_url' => DEFAULT_API_URL))['pb_url'], '/') . '/studyCourses';
    $url = 'https://gptest.archi-lab.io/studyCourses';

    $response = wp_remote_get($url); // get study courses from PB API
    $response_body = json_decode($response['body'], TRUE); // we only need the body of the response
    if(array_key_exists('status', $response_body) && $response_body['status']===404) // if status=404 the api was not found
        return array("ERROR: Could not retrieve API data...");

    $courses = array_column_recursive($response_body,'name'); // go get all study courses
    $degree = array_column_recursive($response_body, 'academicDegree'); // get the academic degree of all couses

    $id = array();

    // dirty implementation to get the ID of each course (which in fact is the self href in the projektbörse api)
    for ($i = 0; $i < count($courses); $i++) {
        array_push($id, $response_body['_embedded']['studyCourses'][$i]['_links']['self']['href']);
    }

    // we substitute the index number-key (0, 1, 2, ...) of the course array with the "href-ID" of the API as the key
    for ($i = 0; $i < count($courses); $i++) {
        $courses[$i] = $courses[$i].' ('.$degree[$i].')'; // course name + academic degree = new full course name

        // key substitution:
        $courses[$id[$i]] = $courses[$i];
        unset($courses[$i]);
    }

   return $courses;
}

function array_column_recursive(array $haystack, $needle) {
    $found = [];
    array_walk_recursive($haystack, function($value, $key) use (&$found, $needle) {
        if ($key == $needle)
            $found[] = $value;
    });
    return $found;
}

// --------------------------- Debugging Section -------------------------------

/* Echo variable
 * Description: Uses <pre> and print_r to display a variable in formated fashion
 */
function echo_log( $what )
{
    echo '<pre>'.print_r( $what, true ).'</pre>';
}

/* Log to File
 * Description: Log into system php error log, usefull for Ajax and stuff that FirePHP doesn't catch
 */
function my_log_file( $msg, $name = '' )
{
    // Print the name of the calling function if $name is left empty
    $trace=debug_backtrace();
    $name = ( '' == $name ) ? $trace[1]['function'] : $name;

    $error_dir = '/home/andreas/Schreibtisch/pb_debug.log';
    $msg = print_r( $msg, true );
    $log = $name . "  |  " . $msg . "\n";
    error_log( $log, 3, $error_dir );
}