pidgin/pidgin

Replace PurpleIdleUiOps with the PurpleIdleUi Interface

2021-10-22, Gary Kramlich
5397330041d6
Replace PurpleIdleUiOps with the PurpleIdleUi Interface

This continues our path down replacing the UiOps with Interfaces so that
developers can write user interfaces in other languages using gobject
introspection.

Testing Done:
Ran pidgin3 and set it to auto idle after 1 minute of system idle time. This attempted to query xscreen saver, but something didn't work there, but that's been happening before this change. Not sure if it's my system or the code just needs fixing.

Ran finch3 set idle time to 1 minute and verified that it set me to away after that minute.

I also used the libpurple idle time for both pidgin3 and finch3 and verified they continued to work as well.

Reviewed at https://reviews.imfreedom.org/r/1091/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* Most code in nat-pmp.h copyright (C) 2007, R. Tyler Ballance, bleep, LLC.
* This file is distributed under the 3-clause (modified) BSD license:
* Redistribution and use in source and binary forms, with or without modification, are permitted
* provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and
* the following disclaimer.
* Neither the name of the bleep. LLC nor the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_NAT_PMP_H
#define PURPLE_NAT_PMP_H
/**
* SECTION:nat-pmp
* @section_id: libpurple-nat-pmp
* @short_description: <filename>nat-pmp.h</filename>
* @title: NAT-PMP Implementation
*/
#include <glib.h>
#define PURPLE_PMP_LIFETIME 3600 /* 3600 seconds */
typedef enum {
PURPLE_PMP_TYPE_UDP,
PURPLE_PMP_TYPE_TCP
} PurplePmpType;
G_BEGIN_DECLS
/**
* purple_pmp_init:
*
* Initialize nat-pmp
*/
void purple_pmp_init(void);
char *purple_pmp_get_public_ip(void);
/**
* purple_pmp_create_map:
* @type: The PurplePmpType
* @privateport: The private port on which we are listening locally
* @publicport: The public port on which we are expecting a response
* @lifetime: The lifetime of the mapping. It is recommended that this
* be PURPLE_PMP_LIFETIME.
*
* Remove the NAT-PMP mapping for a specified type on a specified port
*
* Returns: TRUE if successful; FALSE if unsuccessful
*/
gboolean purple_pmp_create_map(PurplePmpType type, unsigned short privateport,
unsigned short publicport, int lifetime);
/**
* purple_pmp_destroy_map:
* @type: The PurplePmpType
* @privateport: The private port on which the mapping was previously made
*
* Remove the NAT-PMP mapping for a specified type on a specified port
*
* Returns: TRUE if successful; FALSE if unsuccessful
*/
gboolean purple_pmp_destroy_map(PurplePmpType type, unsigned short privateport);
G_END_DECLS
#endif /* PURPLE_NAT_PMP_H */