Pidgin

https://pidgin.im/development/
Admin
Pidgin is a universal instant messaging client that supports multiple chat protocols and enables...
Tokens:29,552
Snippets:266
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Build Pidgin Installers using Makefile.mingw

Source: https://pidgin.im/development/building/2.x.y/windows

This command sequence shows how to build both the offline and online Pidgin installers. It involves navigating to the Pidgin source directory and executing the 'installers' target from the Makefile.mingw. The resulting installers will be placed in the build directory.

```bash
cd $PIDGIN_DEV_ROOT/pidgin-<version>
make -f Makefile.mingw installers
```

--------------------------------

### Install NSIS 2.46 from Source on Linux

Source: https://pidgin.im/development/building/2.x.y/windows

This code block demonstrates how to download, compile, and install NSIS version 2.46 from source on a Linux system. It includes steps for creating a directory, downloading source and zip archives, extracting, compiling with scons, and installing the compiler and core files.

```bash
mkdir nsis; cd nsis
wget https://prdownloads.sourceforge.net/nsis/nsis-2.46-src.tar.bz2?download
wget https://prdownloads.sourceforge.net/nsis/nsis-2.46.zip?download
tar -jxvf nsis-2.46-src.tar.bz2
cd nsis-2.46
scons SKIPSTUBS=all SKIPPLUGINS=all SKIPUTILS=all SKIPMISC=all NSIS_CONFIG_CONST_DATA_PATH=no
sudo scons install-compiler
cd ..
sudo unzip nsis-2.46 -d /usr/local/share
sudo mv /usr/local/share/nsis-2.46/ /usr/local/share/nsis

```

--------------------------------

### Configure Signing Options in local.mak

Source: https://pidgin.im/development/building/2.x.y/windows

This snippet shows how to configure the local.mak file for signing executables using osslsigncode and GPG. It specifies paths to the signing executable, certificate files, and GPG keyring. This is necessary for digitally signing the installer and its components.

```makefile
OSSLSIGNCODE=/mingw32/bin/osslsigncode.exe
SIGNCODE_SPC=/home/user/sekrets/authenticode.spc
SIGNCODE_PVK=/home/user/sekrets/authenticode.pvk
#Set up gpg to use a separate keyring
GPG_SIGN=gpg --no-default-keyring --secret-keyring /path/to/secring.gpg
```

--------------------------------

### Install MSYS2 Dependencies with Pacman

Source: https://pidgin.im/development/building/2.x.y/windows

This command installs essential packages for the MSYS2 build environment. It uses the `pacman` package manager to synchronize repositories and install specified certificates, utilities, and build tools.

```bash
$ pacman -Sy ca-certificates gawk grep make patch tar unzip wget zip
```

--------------------------------

### Customize Pidgin Build with local.mak

Source: https://pidgin.im/development/building/2.x.y/windows

This example demonstrates how to override default installation directories for Pidgin and its core library, Purple, by creating a `local.mak` file. This allows for custom installation paths, such as placing Pidgin in 'Program Files'.

```makefile
#Override the install location
PIDGIN_INSTALL_DIR = /cygdrive/c/Program\ Files/Pidgin
PURPLE_INSTALL_DIR = /cygdrive/c/Program\ Files/Pidgin
```

--------------------------------

### Build Pidgin with MinGW

Source: https://pidgin.im/development/building/2.x.y/windows

This command initiates the build process for Pidgin using the MinGW compiler. It navigates to the Pidgin source directory and executes the 'make' command with a specific Makefile. This process compiles the Pidgin source code and installs the necessary files.

```bash
cd $PIDGIN_DEV_ROOT/pidgin-<version>
make -f Makefile.mingw install
```

--------------------------------

### Verify Authenticode Signatures and Timestamps (Windows)

Source: https://pidgin.im/development/release-process/index.html

This snippet demonstrates how to verify the Authenticode signature and timestamp for Pidgin executable installers on a Windows system. It requires the Platform SDK to be installed. The commands check both offline and standard installer executables.

```batch
signtool.exe verify /pa /tw pidgin-$VERSION-offline.exe
signtool.exe verify /pa /tw pidgin-$VERSION.exe
```

--------------------------------

### Generate Debug Log in Windows Command Prompt

Source: https://pidgin.im/development/debugging

This command navigates to the Pidgin installation directory, starts Pidgin with debugging enabled, and redirects both standard output and standard error to a file named 'debug.log' in the user's profile directory. Ensure the path to Pidgin is adjusted if it's not the default installation location.

```batch
cd "C:\Program Files (x86)\Pidgin"
pidgin.exe --debug 2>&1 > "%USERPROFILE%\debug.log"
```

--------------------------------

### Generate Pidgin Backtrace with GDB on Linux

Source: https://pidgin.im/development/debugging

This command starts Pidgin under GDB and redirects all output, including the backtrace, to a log file. Ensure you have GDB installed and the necessary debug symbols for Pidgin.

```bash
$ gdb --args pidgin --debug |& tee ~/pidgin-backtrace.log
```

--------------------------------

### Compile Pidgin from Source (Linux/macOS)

Source: https://pidgin.im/development/building/2.x.y/index.html

Standard procedure for compiling libpurple, Pidgin, and Finch from source on Unix-like systems. This involves extracting the tarball, navigating to the directory, and running the configure, make, and make install commands. The default installation path is /usr/local, but can be changed using the --prefix option.

```bash
$ tar xjvf pidgin-2.x.y.tar.bz2
$ cd pidgin-2.x.y
$ ./configure && make && sudo make install
```

--------------------------------

### Install Dependencies on Debian/Ubuntu

Source: https://pidgin.im/development/building/2.x.y/index.html

This command automatically installs all necessary development header packages for Pidgin on Debian-based systems like Ubuntu. If it fails, ensure that 'deb-src' lines are present in your /etc/apt/sources.list file.

```bash
sudo apt-get build-dep pidgin
```

--------------------------------

### Initialize Build Environment from Mercurial Source

Source: https://pidgin.im/development/building/2.x.y/index.html

If you have cloned the Pidgin source code from the Mercurial repository, you need to run the autogen.sh script instead of ./configure for the initial setup. This script generates the necessary build files. An error during this process might indicate a need for a newer version of automake.

```bash
$ ./autogen.sh
```

--------------------------------

### Update local.mak for NSIS Compiler Path

Source: https://pidgin.im/development/building/2.x.y/windows

This snippet shows the modification needed in the local.mak file to point to the newly installed NSIS compiler executable. This is a crucial step after compiling and installing NSIS from source to ensure the build process can locate the correct tool.

```makefile
MAKENSIS := /usr/local/bin/makensis

```

--------------------------------

### Create libssp-src.tar.gz Archive

Source: https://pidgin.im/development/building/2.x.y/windows

This command sequence prepares a tarball containing the source code and licenses for the libssp library, a component of GCC. It navigates to the MinGW directory, extracts specific files from the GCC source, and then creates a compressed archive.

```bash
cd $PIDGIN_DEV_ROOT/win32-dev/mingw-4.7.2
mkdir libsspsrctmp
tar -C libsspsrctmp -xf gcc-4.7.2-1-mingw32-src/gcc-4.7.2.tar.bz2 gcc-4.7.2/COPYING3 gcc-4.7.2/COPYING.RUNTIME gcc-4.7.2/libssp --strip-components=1
tar -C libsspsrctmp -czf bin/libssp-src.tar.gz .
rm -r libsspsrctmp
```

--------------------------------

### Verify Authenticode Signature of Installed Pidgin (Windows)

Source: https://pidgin.im/development/release-process/index.html

This command verifies the Authenticode signature and timestamp for an already installed Pidgin executable. This check is performed after installation to ensure the integrity of the application. It requires the Platform SDK.

```batch
signtool.exe verify /pa /tw %ProgramFiles(x86)ால்\Pidgin\pidgin.exe
```

--------------------------------

### Install Dependencies on Fedora/RHEL/CentOS

Source: https://pidgin.im/development/building/2.x.y/index.html

For RPM-based distributions using yum, 'yum-builddep' can install dependencies if a source RPM is available. On newer Fedora versions, 'dnf builddep' from the 'dnf-plugins-core' package is used. For older systems with yum, 'yum-builddep' is in the 'yum-utils' package.

```bash
# For older Fedora/RHEL/CentOS with yum
yum install yum-utils
sudo yum-builddep pidgin

# For newer Fedora with dnf
sudo dnf install 'dnf-command(builddep)'
sudo dnf builddep pidgin
```

--------------------------------

### Execute GDB Commands for Backtrace

Source: https://pidgin.im/development/debugging

These GDB commands are used to run the application, handle specific signals, and generate a full backtrace. This is typically done after starting the application with GDB.

```gdb
(gdb) handle SIGPIPE nostop noprint
(gdb) run
(gdb) bt full
```

--------------------------------

### Verify Authenticode Signature and Timestamp (Windows)

Source: https://pidgin.im/development/release-process

This snippet demonstrates how to verify the Authenticode signature and timestamp for Pidgin executable files on a Windows system using the 'signtool.exe' utility. It requires the Platform SDK to be installed.

```shell
signtool.exe verify /pa /tw pidgin-$VERSION-offline.exe
signtool.exe verify /pa /tw pidgin-$VERSION.exe
```

```shell
signtool.exe verify /pa /tw %ProgramFiles(x86)ுக்கு\Pidgin\pidgin.exe
```

--------------------------------

### Get Global PurpleMediaManager Instance

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Returns a global instance of the PurpleMediaManager. This is a singleton-like pattern ensuring a single point of access to the manager.

```python
# Returns a global instance of the PurpleMediaManager.
*_get
```

--------------------------------

### Get GStreamer Plugins List

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api

Returns a list of available audio or video GStreamer plugins, such as 'v4lsrc' for video or 'alsasrc' for audio. This helps in identifying compatible media sources.

```python
#*_get_plugins            # Return a list of audio/video GStreamer plugins (eg. v4lsrc, alsasrc)
```

--------------------------------

### Configure Pidgin Build Environment with local.mak

Source: https://pidgin.im/development/building/2.x.y/windows

This snippet shows how to create a local.mak file to override default Makefile variables for cross-compiling Pidgin. It specifies the shell, C compiler, message formatter, NSIS compiler, resource compiler, strip utility, and merge tool, along with include and library paths for win32api.

```makefile
SHELL := /bin/bash
CC := /usr/bin/i586-mingw32msvc-cc
GMSGFMT := msgfmt
MAKENSIS := /usr/bin/makensis
WINDRES := /usr/bin/i586-mingw32msvc-windres
STRIP := /usr/bin/i586-mingw32msvc-strip
INTLTOOL_MERGE := /usr/bin/intltool-merge

INCLUDE_PATHS := -I$(PIDGIN_TREE_TOP)/../win32-dev/w32api/include
LIB_PATHS := -L$(PIDGIN_TREE_TOP)/../win32-dev/w32api/lib

```

--------------------------------

### Get GStreamer Plugins List

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Returns a list of available audio or video GStreamer plugins, such as 'v4lsrc' for video or 'alsasrc' for audio. This requires a type parameter specifying audio or video.

```python
# Return a list of audio/video GStreamer plugins (eg. v4lsrc, alsasrc)
*_get_plugins
```

--------------------------------

### Configure PATH for MinGW GCC

Source: https://pidgin.im/development/building/2.x.y/windows

This bash command adds the MinGW GCC binary directory to the system's PATH environment variable. This ensures that the MinGW compiler and related tools are accessible from the command line. It is typically added to the user's shell configuration file like .bashrc.

```bash
export PATH=/cygdrive/c/devel/pidgin-devel/win32-dev/mingw-4.7.2/bin:$PATH
```

--------------------------------

### Disable Signing Options in local.mak

Source: https://pidgin.im/development/building/2.x.y/windows

This snippet demonstrates how to disable code signing in the local.mak file. It sets osslsigncode and GPG_SIGN to echo commands, effectively bypassing the signing process. This is useful for personal builds or when code signing is not required.

```makefile
#Disable Signing
OSSLSIGNCODE=echo ***Bypassing signcode***
GPG_SIGN=echo ***Bypassing gpg***
```

--------------------------------

### Initialize PurpleMedia Instance

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Creates a PurpleMedia instance, potentially with a flag to indicate if it's the initiator or responder. This function is likely part of a larger media management system.

```python
# Creates a PurpleMedia instance. Probably have a flag as to whether it's the initiator or responder
*_initiate
```

--------------------------------

### Attach GDB to Running Finch Process on Linux

Source: https://pidgin.im/development/debugging

This method involves starting Finch normally and then attaching GDB to its running process using the process ID. This is useful for console-based applications like Finch.

```bash
$ gdb finch <pid>
```

--------------------------------

### General Development Practices

Source: https://pidgin.im/development/faq

Guidelines for common development tasks such as retrieving environment variables and string formatting.

```APIDOC
## General Development Practices

### Description
This section covers general development practices, including how to access environment variables and use string formatting functions.

### Functions

#### Get Environment Variable

##### Description
Retrieves the value of an environment variable.

##### Method
`g_getenv()`

##### Parameters
- **name** (const char*) - The name of the environment variable.

##### Returns
- A pointer to the value of the environment variable, or `NULL` if it is not found.

#### String Formatting

##### Description
Uses GLib wrapper functions for string formatting instead of standard C library functions like `snprintf()` and `vsnprintf()` for better cross-platform compatibility and safety.

##### Methods
- `g_snprintf()`
- `g_vsnprintf()`

#### Settings Directory

##### Description
Provides a way to access the application's settings directory.

##### Method
`purple_settings_get_dir()`

##### Returns
- A string representing the path to the settings directory.
```

--------------------------------

### Generate Debug Log in Linux/macOS Terminal

Source: https://pidgin.im/development/debugging

This command starts Pidgin with debugging enabled and pipes all output (stdout and stderr) to a file named 'debug.log' in the user's home directory. This is useful for capturing detailed application behavior before a crash or issue occurs.

```bash
pidgin --debug |& tee ~/debug.log
```

--------------------------------

### Upload API Documentation to Developer Server

Source: https://pidgin.im/development/release-process/index.html

These commands use SCP to securely copy the generated API documentation (HTML format) from a local build to the developer website server. The documentation is organized by version and project (libpurple, pidgin, finch).

```bash
scp docs/reference/libpurple/html nicobar.pidgin.im:/srv/www/developer.pidgin.im/doxygen/x.y.z/libpurple/
scp docs/reference/pidgin/html nicobar.pidgin.im:/srv/www/developer.pidgin.im/doxygen/x.y.z/pidgin/
scp docs/reference/finch/html nicobar.pidgin.im:/srv/www/developer.pidgin.im/doxygen/x.y.z/finch/
```

--------------------------------

### File Handling and Paths

Source: https://pidgin.im/development/faq/index.html

Explanations regarding file path separators, binary file modes, and the usage of specific directory variables.

```APIDOC
## Files and File Paths

### What do I do with `DATADIR`, `LOCALEDIR`, and `LIBDIR`?

#### Description
`DATADIR`, `LOCALEDIR`, and `LIBDIR` are defined as functions on Windows builds. Direct string concatenation with these can break the build. Use `G_DIR_SEPARATOR_S` for path construction.

#### Method
N/A (Code Usage)

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
```c
// Incorrect on Windows:
// printf("File in DATADIR is: %s\n", DATADIR G_DIR_SEPARATOR_S "pic.png");

// Correct cross-platform approach:
printf("File in DATADIR is: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");
```

#### Success Response (200)
N/A

#### Response Example
N/A

### Why are files opened with mode `b`?

#### Description
Opening files in binary mode (`'b'`) prevents Windows-specific newline translations (`<CR><LF>`) from occurring. This ensures accurate byte counts and consistent file handling across different operating systems.

#### Method
N/A (File Opening Mode)

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
```c
// Example of opening a file in binary mode
FILE *fp = fopen("myfile.bin", "rb");
```

#### Success Response (200)
N/A

#### Response Example
N/A

### Why are `G_DIR_SEPARATOR_S` and `G_DIR_SEPARATOR` used everywhere?

#### Description
These GLib macros are used to ensure cross-platform compatibility for file paths. They abstract the operating system's specific directory separator (e.g., `\` on Windows, `/` on UNIX-like systems), simplifying path manipulation and maintaining portability.

#### Method
N/A (Code Usage)

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
```c
// Constructing a path using GLib's separator macro
char *full_path = g_build_filename(dir1, dir2, filename, NULL);
```

#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### File Handling and Paths

Source: https://pidgin.im/development/faq

Information on handling file paths, directory separators, and file opening modes for cross-platform compatibility.

```APIDOC
## File Handling and Paths

### Description
This section provides guidance on using directory separator macros and understanding file opening modes to ensure cross-platform compatibility.

### Concepts

#### Directory Separator Macros

##### Description
`G_DIR_SEPARATOR_S` and `G_DIR_SEPARATOR` are GLib macros used to handle directory separators consistently across different operating systems (e.g., `\` on Windows, `/` on UNIX-like systems).

##### Usage Example
```c
printf("File path: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");
```

#### File Opening Mode `b`

##### Description
Opening files with mode `b` (binary mode) is crucial on Windows systems to prevent default text translations (like `<CR><LF>` for newlines). This ensures accurate byte counts and prevents errors when comparing read data with `stat()` results.

##### Example
When opening files, use modes like `"rb"` (read binary) or `"wb"` (write binary).

#### Predefined Directory Variables

##### Description
`DATADIR`, `LOCALEDIR`, and `LIBDIR` are defined as functions in the Windows build of LibPurple. Direct string concatenation with these variables can break the Windows build. Use the provided separator macros for correct path construction.
```

--------------------------------

### General Development Practices

Source: https://pidgin.im/development/faq/index.html

Information on retrieving environment variables, string formatting functions, and versioning schemes.

```APIDOC
## General

### What should I do to get the contents of an environment variable?

#### Description
Use the GLib function `g_getenv()` to retrieve the value of an environment variable.

#### Method
N/A (Function Call)

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
```c
char *path_value = g_getenv("PATH");
if (path_value) {
    // Use the environment variable value
    g_free(path_value);
}
```

#### Success Response (200)
N/A

#### Response Example
N/A

### Should I use `snprintf()` or `vsnprintf()`?

#### Description
It is recommended to use GLib's wrapper functions, `g_snprintf()` and `g_vsnprintf()`, instead of the standard C library functions for string formatting.

#### Method
N/A (Function Usage)

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
```c
char buffer[100];
g_snprintf(buffer, sizeof(buffer), "Hello, %s!", "World");
```

#### Success Response (200)
N/A

#### Response Example
N/A

### How do I get the settings directory?

#### Description
Information on retrieving the settings directory is not explicitly provided in this FAQ section, but typically involves GLib functions or platform-specific methods.

#### Method
N/A

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

#### Success Response (200)
N/A

#### Response Example
N/A

### What is the versioning scheme?

#### Description
Information regarding the versioning scheme of LibPurple is not detailed in this FAQ section.

#### Method
N/A

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Configure Voice and Video Support - C/Shell

Source: https://pidgin.im/development/voice-and-video

This snippet shows the expected output from the configure script indicating successful build with voice and video support. It's a confirmation step during the build process.

```shell
> Build with voice and video…. yes
```

--------------------------------

### Get Candidates per Stream

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Fetches the list of ICE candidates associated with a particular stream. This is important for network connectivity.

```python
# gets candidates per stream
*_candidates
```

--------------------------------

### Plugins and Protocols

Source: https://pidgin.im/development/faq

Guidelines for handling global variables and exported functions within plugins and protocols.

```APIDOC
## Plugins and Protocols

### Description
This section offers advice on managing global variables and implementing exported functions within the context of LibPurple plugins and protocols.

### Best Practices

#### Global Variables

##### Description
Provides recommendations on how to handle global variables within plugins and protocols to avoid conflicts and ensure proper scope management.

#### Exported Functions

##### Description
Details the correct approach for defining and using "exported" functions that are intended to be called from outside the plugin or protocol module.
```

--------------------------------

### Get Codecs per Session

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Retrieves the codecs currently configured for a specific session. This is useful for verifying media capabilities.

```python
# gets codecs per sessions
*_codecs
```

--------------------------------

### Get Environment Variable - C

Source: https://pidgin.im/development/faq

Retrieves the value of an environment variable. This function is part of the GLib library and provides a cross-platform way to access environment settings.

```c
g_getenv("VARIABLE_NAME");
```

--------------------------------

### Plugins and Protocols

Source: https://pidgin.im/development/faq/index.html

Guidelines for handling global variables and exported functions within plugins and protocols.

```APIDOC
## Plugins and Protocols

### How should I handle global variables?

#### Description
This section discusses the recommended approach for managing global variables within plugins and protocols, though the specific recommendations are not detailed in the provided text.

#### Method
N/A

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

#### Success Response (200)
N/A

#### Response Example
N/A

### What should I do for “exported” functions?

#### Description
Guidance on how to handle "exported" functions in the context of plugins and protocols is mentioned, but the specific instructions are omitted from the provided text.

#### Method
N/A

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Get Participant Names

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Fetches participant names, either for the entire conference or for a specific session. This is useful for displaying user information.

```python
# gets participant names by conference or by session
*_participants
```

--------------------------------

### Get Session IDs in Conference

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Retrieves all active session IDs within the current conference. This provides an overview of ongoing communication.

```python
# gets session_ids in the conference
*_sessions
```

--------------------------------

### Headers

Source: https://pidgin.im/development/faq/index.html

Troubleshooting common issues related to header files.

```APIDOC
## Headers

### Why is win32dep.h causing problems for me?

#### Description
This FAQ entry addresses potential issues arising from the `win32dep.h` header file, but the specific details or solutions are not provided in the given text.

#### Method
N/A

#### Endpoint
N/A

#### Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Get Global GStreamer Pipeline

Source: https://pidgin.im/development/voice-and-video/voice-and-video-api/index.html

Retrieves a global GStreamer pipeline that can be used by all PurpleMedia instances. This promotes resource sharing and consistency.

```python
# Returns a global pipeline to be used for all PurpleMedia instances.
*_get_pipeline
```
Tokens:
Raw